Skip to content
Workshape Catalyst Operator Docs

Conversation Files

Download or display an artifact of a conversation

Section titled “Download or display an artifact of a conversation”

GET /api/v1/conversations/{conversationId}/artifacts/{artifactId}/content

Operation
conversations.artifacts.get_content
Accepts
sessionCookie, sessionToken
Scope
conversation:read
Effect
reading
Rate class
read

Parameters

  • conversationId string in path, required
  • artifactId string in path, required
  • inline string in query, optional

Answers

  • 200 The content itself

    application/octet-stream: string (binary)

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Read the page preview of an artifact

Section titled “Read the page preview of an artifact”

GET /api/v1/conversations/{conversationId}/artifacts/{artifactId}/preview

Operation
conversations.artifacts.get_preview
Accepts
sessionCookie, sessionToken
Scope
conversation:read
Effect
reading
Rate class
read

Parameters

  • conversationId string in path, required
  • artifactId string in path, required

Answers

  • 200 The result

    application/json: ArtifactPreviewResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Prepare the page preview of an artifact

Section titled “Prepare the page preview of an artifact”

POST /api/v1/conversations/{conversationId}/artifacts/{artifactId}/preview

Operation
conversations.artifacts.start_preview
Accepts
sessionCookie, sessionToken
Scope
conversation:read
Effect
changing
Rate class
write

Parameters

  • conversationId string in path, required
  • artifactId string in path, required

Answers

  • 200 The result

    application/json: ArtifactPreviewResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Render a failed artifact preview again

Section titled “Render a failed artifact preview again”

POST /api/v1/conversations/{conversationId}/artifacts/{artifactId}/preview/retry

Operation
conversations.artifacts.retry_preview
Accepts
sessionCookie, sessionToken
Scope
conversation:read
Effect
changing
Rate class
write

Parameters

  • conversationId string in path, required
  • artifactId string in path, required

Answers

  • 200 The result

    application/json: ArtifactPreviewResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Read the page preview of a sent attachment

Section titled “Read the page preview of a sent attachment”

GET /api/v1/conversations/{conversationId}/attachments/{attachmentId}/preview

Operation
conversations.attachments.get_preview
Accepts
sessionCookie, sessionToken
Scope
conversation:read
Effect
reading
Rate class
read

Parameters

  • conversationId string in path, required
  • attachmentId string in path, required

Answers

  • 200 The result

    application/json: ArtifactPreviewResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Prepare the page preview of a sent attachment

Section titled “Prepare the page preview of a sent attachment”

POST /api/v1/conversations/{conversationId}/attachments/{attachmentId}/preview

Operation
conversations.attachments.start_preview
Accepts
sessionCookie, sessionToken
Scope
conversation:read
Effect
changing
Rate class
write

Parameters

  • conversationId string in path, required
  • attachmentId string in path, required

Answers

  • 200 The result

    application/json: ArtifactPreviewResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

List the attachments of the unsent message

Section titled “List the attachments of the unsent message”

GET /api/v1/conversations/{conversationId}/draft-attachments

Operation
conversations.draft_attachments.list
Accepts
sessionCookie, sessionToken
Scope
conversation:read
Effect
reading
Rate class
read

Parameters

  • conversationId string in path, required
  • limit integer in query, optional, default 50, minimum 1, maximum 200
  • cursor string in query, optional, minLength 1

Answers

  • 200 One page of the list

    application/json: object

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Upload an attachment for the next message

Section titled “Upload an attachment for the next message”

POST /api/v1/conversations/{conversationId}/draft-attachments

Operation
conversations.draft_attachments.upload
Accepts
sessionCookie, sessionToken
Scope
conversation:write
Effect
changing
Rate class
write

Parameters

  • conversationId string in path, required

Request body

multipart/form-data: object

  • file string (binary) required

Answers

  • 200 The result

    application/json: DraftAttachmentUploadResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Remove a draft attachment

Section titled “Remove a draft attachment”

DELETE /api/v1/conversations/{conversationId}/draft-attachments/{attachmentId}

Operation
conversations.draft_attachments.delete
Accepts
sessionCookie, sessionToken
Scope
conversation:write
Effect
changing
Rate class
write

Parameters

  • conversationId string in path, required
  • attachmentId string in path, required

Answers

  • 200 The result

    application/json: DraftAttachment

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Process a failed draft attachment again

Section titled “Process a failed draft attachment again”

POST /api/v1/conversations/{conversationId}/draft-attachments/{attachmentId}/retry

Operation
conversations.draft_attachments.retry
Accepts
sessionCookie, sessionToken
Scope
conversation:write
Effect
changing
Rate class
write

Parameters

  • conversationId string in path, required
  • attachmentId string in path, required

Answers

  • 200 The result

    application/json: DraftAttachmentUploadResponse

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Download or display a file of a conversation

Section titled “Download or display a file of a conversation”

GET /api/v1/conversations/{conversationId}/files/{fileId}/content

Operation
conversations.files.get_content
Accepts
sessionCookie, sessionToken
Scope
conversation:read
Effect
reading
Rate class
read

Parameters

  • conversationId string in path, required
  • fileId string in path, required
  • download string in query, optional

Answers

  • 200 The content itself

    application/octet-stream: string (binary)

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 404 NOT_FOUND: The resource does not exist, is not visible to the caller, or the instance runs without this operation.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.