Overview

The Traversal API lets you start investigations, send follow-up questions, manage knowledge files, and read audit logs from your own tools. To get started, create an API key and make your first request.

Base URL

All endpoints are served from:

https://api.traversal.com

Single-tenant SaaS and BYOC customers use the API endpoint exposed by their dedicated deployment. See single-tenant SaaS or Bring Your Own Cloud.

Versioning

The Sessions and Knowledge Files APIs are served under /v1. The Event Logs API is in beta and is served under /v0 until it stabilizes.

Error format

Errors use this envelope:

{
  "error": {
    "code": "resource_exhausted",
    "message": "A human-readable explanation of the error.",
    "retry_after": 30
  }
}

Field	Type	Description
`error.code`	`string`	Stable machine-readable category. Use this field instead of matching the message text.
`error.message`	`string`	Human-readable explanation of the error.
`error.retry_after`	`integer`	Optional suggested seconds to wait before retrying. Present only when the server can recommend a delay, such as some `429` and `503` responses.

When retry_after is present in the body, the response also includes a standard Retry-After HTTP header with the same value.

Status codes

Status code	Meaning	When it occurs
`400`	Bad Request	An invalid body, path, query parameter, or header value. The `message` identifies the failed validation.
`401`	Unauthorized	Missing, invalid, or revoked API key.
`403`	Forbidden	Insufficient role, ownership, permission, or endpoint-specific access.
`404`	Not Found	The requested resource does not exist or is not visible to the authenticated organization.
`405`	Method Not Allowed	The path exists, but it does not support the requested HTTP method. The response includes an `Allow` header.
`409`	Conflict	The request conflicts with the current resource state.
`412`	Precondition Failed	A conditional request validator such as `If-Match` is stale.
`413`	Content Too Large	The request body exceeds the endpoint limit.
`415`	Unsupported Media Type	The request uses an unsupported content format or encoding.
`429`	Too Many Requests	The organization has reached an endpoint-specific concurrency or rate limit.
`500`	Internal Server Error	An unexpected error occurred on the server.
`503`	Service Unavailable	API infrastructure is not available.

Individual endpoints may define additional status codes specific to their behavior. See the relevant API page for details.

Get Started

Architecture

Set up

Using Traversal

API

Security & Trust

Changelog

Base URL

Versioning

Error format

Status codes

​Base URL

​Versioning

​Error format

​Status codes

Base URL

Versioning

Error format

Status codes