Create a session

POST

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"
}
'

import requests

url = "https://api.traversal.com/v1/sessions"

payload = {
    "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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.traversal.com/v1/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.traversal.com/v1/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.traversal.com/v1/sessions"

	payload := strings.NewReader("{\n  \"input\": \"Our checkout service started returning 500 errors at 2024-03-15T14:30:00Z. Error rate jumped from 0.1% to 15%.\",\n  \"title\": \"Elevated error rate in checkout service\",\n  \"time\": \"2024-03-15T14:30:00Z\",\n  \"idempotency_key\": \"pagerduty-incident-P12345\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.traversal.com/v1/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input\": \"Our checkout service started returning 500 errors at 2024-03-15T14:30:00Z. Error rate jumped from 0.1% to 15%.\",\n  \"title\": \"Elevated error rate in checkout service\",\n  \"time\": \"2024-03-15T14:30:00Z\",\n  \"idempotency_key\": \"pagerduty-incident-P12345\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.traversal.com/v1/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"input\": \"Our checkout service started returning 500 errors at 2024-03-15T14:30:00Z. Error rate jumped from 0.1% to 15%.\",\n  \"title\": \"Elevated error rate in checkout service\",\n  \"time\": \"2024-03-15T14:30:00Z\",\n  \"idempotency_key\": \"pagerduty-incident-P12345\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "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",
      "markdown_content": "## Investigation Summary\n\nI investigated the elevated error rate...",
      "created_at": "2024-03-15T14:38:12Z"
    }
  ]
}

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "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",
      "markdown_content": "## Investigation Summary\n\nI investigated the elevated error rate...",
      "created_at": "2024-03-15T14:38:12Z"
    }
  ]
}

{
  "error": {
    "message": "<string>",
    "retry_after": 123
  }
}

{
  "error": {
    "message": "<string>",
    "retry_after": 123
  }
}

{
  "error": {
    "message": "<string>",
    "retry_after": 123
  }
}

{
  "error": {
    "message": "<string>",
    "retry_after": 123
  }
}

{
  "error": {
    "message": "<string>",
    "retry_after": 123
  }
}

{
  "error": {
    "message": "<string>",
    "retry_after": 123
  }
}

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.

thinking_mode

enum<string>

default:auto

Controls how much investigation depth Traversal applies.

auto — Traversal classifies the request and picks a depth.
deep — force a thorough root-cause analysis.
fast — run a quick, exploratory pass.

Available options:

auto,

deep,

fast

Response

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

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.
cancelled — the investigation was cancelled.

Available options:

running,

idle,

follow_up_running,

failed,

cancelled

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}.

Show child attributes

⌘I

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"
}
'

import requests

url = "https://api.traversal.com/v1/sessions"

payload = {
    "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"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
  })
};

fetch('https://api.traversal.com/v1/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.traversal.com/v1/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.traversal.com/v1/sessions"

	payload := strings.NewReader("{\n  \"input\": \"Our checkout service started returning 500 errors at 2024-03-15T14:30:00Z. Error rate jumped from 0.1% to 15%.\",\n  \"title\": \"Elevated error rate in checkout service\",\n  \"time\": \"2024-03-15T14:30:00Z\",\n  \"idempotency_key\": \"pagerduty-incident-P12345\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.traversal.com/v1/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input\": \"Our checkout service started returning 500 errors at 2024-03-15T14:30:00Z. Error rate jumped from 0.1% to 15%.\",\n  \"title\": \"Elevated error rate in checkout service\",\n  \"time\": \"2024-03-15T14:30:00Z\",\n  \"idempotency_key\": \"pagerduty-incident-P12345\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.traversal.com/v1/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"input\": \"Our checkout service started returning 500 errors at 2024-03-15T14:30:00Z. Error rate jumped from 0.1% to 15%.\",\n  \"title\": \"Elevated error rate in checkout service\",\n  \"time\": \"2024-03-15T14:30:00Z\",\n  \"idempotency_key\": \"pagerduty-incident-P12345\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "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",
      "markdown_content": "## Investigation Summary\n\nI investigated the elevated error rate...",
      "created_at": "2024-03-15T14:38:12Z"
    }
  ]
}

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "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",
      "markdown_content": "## Investigation Summary\n\nI investigated the elevated error rate...",
      "created_at": "2024-03-15T14:38:12Z"
    }
  ]
}

{
  "error": {
    "message": "<string>",
    "retry_after": 123
  }
}

{
  "error": {
    "message": "<string>",
    "retry_after": 123
  }
}

{
  "error": {
    "message": "<string>",
    "retry_after": 123
  }
}

{
  "error": {
    "message": "<string>",
    "retry_after": 123
  }
}

{
  "error": {
    "message": "<string>",
    "retry_after": 123
  }
}

{
  "error": {
    "message": "<string>",
    "retry_after": 123
  }
}

Get Started

Architecture

Set up

Using Traversal

API

Security & Trust

Changelog

Authorizations

Body

Response