BilbyHelp Center
Open Bilby

Download a conversation artifact

GET
/api/v1/conversations/{id}/artifacts/{name}/download

Returns current artifact bytes with Content-Type, Content-Length and Content-Disposition headers. Uses the same content resolution as browser downloads, including stored XLSX/DOCX specifications. Requires bearer or session auth. Deleting the artifact makes this endpoint return 404. Does not publish the artifact or create an attachment snapshot.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Personal API key (Authorization: Bearer pulse_...). Scoped to selected organizations (or all current ones); acts as the creating user. If the key covers more than one organization, pass its organizationId on each request.

Path Parameters

id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
name*string
Length1 <= length <= 255

Query Parameters

organizationId?string

Organization to operate in. Optional when the API key is bound to exactly one organization (inferred). Required for keys that cover several or all organizations, and for session cookie auth.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
workspaceId?stringDeprecated

Deprecated: the old name of organizationId, still accepted. If both are sent, they must match.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

Artifact bytes; Content-Type reflects the artifact's media type

response?fileapplication/octet-stream
Formatbinary
Example Request
curl -X GET 'https://pulse.bilby.ai/api/v1/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08/artifacts/string/download' \  -H 'Authorization: Bearer YOUR_API_KEY'
Example Response
"string"

List conversation artifacts GET

Lists current artifacts, including sandbox_execute outputs, without creating attachment rows. Each downloadUrl is an authenticated API endpoint returning bytes, not a signed storage URL. Regenerating a filename replaces its current contents; this is not a version history. size is stored artifact size; compiled XLSX/DOCX specifications may download at a different size.

Health check GET

Liveness probe for the Bilby public API mount.