Scribe Chat API

Send messages to your scribes via the API. This creates a session and runs it asynchronously.

You don't have any scribes yet. This page will have specific examples once you create your first scribe.

Send Message to Scribe

POST /api/v1/scribes/:id/chat

Send a message to a scribe. This creates a session and runs it asynchronously.

Headers:

X-Api-Key: your_api_key_here
Content-Type: application/json

Body Parameters:

• message (optional, string) - The user message.
• end_session_immediately (optional, boolean) - If true, marks the session as completed immediately after enqueue.

Example Request:

Add a scribe to your Obelisk to see an example request.

Response:

{
  "session_id": "uuid-of-session"
}

Tip: You can view the session in the UI via the scribe show page Sessions list; click "View Chat".

Asynchronous Processing

When you send a message to a scribe, the API immediately returns a session ID. The scribe processes the message asynchronously in the background.

To check the status or results of the session, navigate to the scribe's page in your Obelisk dashboard and view the session details.

Session Flow:

API call creates a new session
Session ID is returned immediately
Scribe processes the message in the background
Results are available in the Obelisk UI

End Session Immediately

If you want the session to be marked as completed immediately after processing the initial message, set end_session_immediately to true. This is useful for one-off requests.

Example:

curl -X POST \
  "https://obelisk.li/api/v1/scribes/SCRIBE_ID/chat" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: your_api_key_here" \
  -d '{
    "message": "Generate the report",
    "end_session_immediately": true
  }'

← Previous: Entries Next: Error Handling →