Skip to main content
POST
/
v1
/
sessions
Create a session
curl --request POST \
  --url https://api.traversal.com/v1/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": "Our checkout service started returning 500 errors at 2024-03-15T14:30:00Z. Error rate jumped from 0.1% to 15%.",
  "title": "Elevated error rate in checkout service",
  "time": "2024-03-15T14:30:00Z",
  "idempotency_key": "pagerduty-incident-P12345"
}
'
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "running",
  "input": "Our checkout service started returning 500 errors at 2024-03-15T14:30:00Z. Error rate jumped from 0.1% to 15%.",
  "created_at": "2024-03-15T14:35:00Z",
  "title": "Elevated error rate in checkout service",
  "updated_at": "2024-03-15T14:38:12Z",
  "messages": [
    {
      "id": "msg-001-uuid",
      "role": "user",
      "markdown_content": "## Investigation Summary\n\nI investigated the elevated error rate...",
      "created_at": "2024-03-15T14:38:12Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.traversal.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token in the Authorization header — for example, Authorization: Bearer trv_ak_your_api_key_here. Each key is bound to a specific user and organization.

Body

application/json
​
input
string
required

The incident description or question to investigate.

​
idempotency_key
string
required

Unique client-generated key for idempotent creation. Submitting the same key twice returns the original session (with 200 OK) rather than creating a new one. Use a value tied to the upstream event you are reacting to (e.g., a PagerDuty incident ID) so retries don't duplicate sessions.

Maximum string length: 128
​
title
string | null

A short label for the session. Auto-generated if omitted.

Maximum string length: 256
​
time
string<date-time> | null

ISO-8601 timestamp of when the incident occurred.

Response

Idempotency key matched an existing session; the existing session is returned unchanged.

​
id
string<uuid>
required

Unique session identifier.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
status
enum<string>
required
  • running — a new investigation is in progress.
  • idle — investigation is complete and ready for follow-ups.
  • follow_up_running — a follow-up message is being processed.
  • failed — the investigation or follow-up errored or timed out.
Available options:
running,
idle,
follow_up_running,
failed
​
input
string
required

The original incident description or question.

Example:

"Our checkout service started returning 500 errors at 2024-03-15T14:30:00Z. Error rate jumped from 0.1% to 15%."

​
created_at
string<date-time>
required

When the session was created (UTC).

Example:

"2024-03-15T14:35:00Z"

​
title
string | null

Human-readable session title.

Example:

"Elevated error rate in checkout service"

​
updated_at
string<date-time> | null

When the session was last updated (UTC).

Example:

"2024-03-15T14:38:12Z"

​
messages
object[] | null

Conversation history. Only populated on GET /v1/sessions/{session_id}.