ArtifactService

CreateArtifact

Create a new artifact.

post/api/v1/artifacts

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/artifacts
  • Auth: HTTP bearer

Request body

conversationIdstring

Set to link the new artifact to a conversation at create time. Legal only for the conversation's author. Equivalent to a links entry with relation ATTACHED_TO, entity_type CONVERSATION, and this conversation_id as entity_id.

titlestring
summarystring
storageClass'ARTIFACT_STORAGE_CLASS_UNSPECIFIED' | 'ARTIFACT_STORAGE_CLASS_FILE' | 'ARTIFACT_STORAGE_CLASS_STRUCTURED' | 'ARTIFACT_STORAGE_CLASS_BLOB'
  • ARTIFACT_STORAGE_CLASS_UNSPECIFIED: The storage class is not specified.
  • ARTIFACT_STORAGE_CLASS_FILE: Bytes in remote_files, previewable by MIME type.
  • ARTIFACT_STORAGE_CLASS_STRUCTURED: Content is the JSON payload, no file.
  • ARTIFACT_STORAGE_CLASS_BLOB: Bytes in remote_files, opaque, download only.
createdVia'ARTIFACT_CREATED_VIA_UNSPECIFIED' | 'ARTIFACT_CREATED_VIA_AGENT' | 'ARTIFACT_CREATED_VIA_CANVAS' | 'ARTIFACT_CREATED_VIA_UPLOAD'

Which surface wrote the artifact.

  • ARTIFACT_CREATED_VIA_UNSPECIFIED: The producing surface is not specified.
  • ARTIFACT_CREATED_VIA_AGENT: An agent wrote the artifact.
  • ARTIFACT_CREATED_VIA_CANVAS: Canvas wrote the artifact.
  • ARTIFACT_CREATED_VIA_UPLOAD: A direct upload wrote the artifact.
payloadobject

Required for STRUCTURED and rejected otherwise. The serialized payload must not exceed 1 MiB.

Response

A successful response.

Changes

No recorded changes to this operation across all 1 revision of this API.