Documentation

API Documentation

POST

/studio/pickaxe/history

Fetch specific Pickaxe chat history.

pickaxeIdstringRequired

The unique identifier for the Pickaxe whose chat history you want to retrieve.

userIdstringOptional

Optional user identifier or email to filter history by user instead of Pickaxe.

skipnumberOptionalDefaults to 0

The number of recent conversations to skip.

limitnumberOptionalDefaults to 10

The maximum number of recent conversations to return.

lastDaysnumberOptional

Optional filter for conversations updated within the last N days.

formatstringOptional

The desired output format for the chat history. Can be "raw" or "messages". Defaults to "messages".

GET

/studio/pickaxe/<pickaxe_id>/documents

List all knowledge-base documents currently attached to a specific Pickaxe.

pickaxeIdstringRequired

The unique identifier for the Pickaxe whose attached documents you want to retrieve.

GET

/studio/pickaxe/<pickaxe_id>

Get the full Studio API representation of a Pickaxe, including generic configuration fields and attached documents.

pickaxeIdstringRequired

The unique identifier for the Pickaxe you want to retrieve.

POST

/studio/pickaxe/create

Create a new Pickaxe with generic Pickaxe fields and optionally attach existing document IDs. Actions and MCP server configuration are not supported in the Studio API.

pickaxeIdstringOptional

Optional custom Pickaxe ID. If omitted, one will be generated automatically.

documentIdsstring[]Optional

Optional list of existing Studio document IDs to attach when the Pickaxe is created.

dataobjectOptional

Generic Pickaxe fields to create. Most non-system Pickaxe fields are supported. Common fields are shown below.

formtitlestringOptional

The Pickaxe title.

formdescriptionstringOptional

The Pickaxe description.

rolestringOptional

The Pickaxe system prompt.

modelstringOptional

The model slug to use for the Pickaxe.

chatflagbooleanOptional

Whether the Pickaxe is a chat Pickaxe.

promptframestringOptional

Prompt frame / starter messages JSON string for the Pickaxe.

placeholdertextstringOptional

Placeholder text shown in the input UI.

documentuploadtypestringOptional

Document upload mode for the Pickaxe.

icebreakersstring[]Optional

Optional starter prompts shown to the end user.

reasoningeffortstringOptional

Optional reasoning effort value for supported reasoning models.

PATCH

/studio/pickaxe/<pickaxe_id>

Update generic Pickaxe configuration fields and optionally replace, add, or remove attached document IDs. Actions and MCP server configuration are not supported in the Studio API.

pickaxeIdstringRequired

The unique identifier for the Pickaxe you want to update.

documentIdsstring[]Optional

If provided, replaces the Pickaxe's attached documents with exactly this set.

addDocumentIdsstring[]Optional

Optional list of document IDs to add without replacing the existing attachments.

removeDocumentIdsstring[]Optional

Optional list of document IDs to remove without replacing the entire attachment set.

dataobjectOptional

The generic Pickaxe fields to update. You can use raw Pickaxe field names such as formtitle/formdescription, or the aliases name/description.

namestringOptional

Alias for formtitle.

descriptionstringOptional

Alias for formdescription.

formtitlestringOptional

The Pickaxe title.

formdescriptionstringOptional

The Pickaxe description.

rolestringOptional

The system prompt for the Pickaxe.

modelstringOptional

The model slug to use for the Pickaxe.

chatflagbooleanOptional

Whether the Pickaxe is a chat Pickaxe.

placeholdertextstringOptional

Placeholder text shown in the input UI.

documentuploadtypestringOptional

Document upload mode for the Pickaxe.