Skip to Content

Get a span

GEThttps://api.respan.ai/api/request-logs/{unique_id}/

Returns the full span, including evaluation scores and credit and budget information (limit_info). Metadata keys beginning with _ are reserved for platform use and omitted from span and trace read responses.

Servers

https://api.respan.ai: Respan API Server

Authentication

RespanApiKey

Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.

HTTP scheme: bearer; format: Respan API key.

HTTP
Authorization: Bearer $RESPAN_API_KEY

Or:

DashboardJwt

Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.

HTTP scheme: bearer; format: Dashboard JWT.

HTTP
Authorization: Bearer $RESPAN_DASHBOARD_JWT

Path parameters

Parameter Type Required Description and constraints
unique_id string Required
The unique ID of the log to get.

Responses

200

Successful response for Retrieve span

application/json

Field Type Requirement Description and constraints
$ object Body
Full customer-facing span detail. Additional stored or enrichment fields may be present. For usage-capped records, the server can instead return a reduced object with blurred: true.
Additional properties are allowed
id string Required in parent
Span ID (alias of unique_id).
unique_id string Optional
Stored unique span ID.
span_unique_id string Optional
Tracing span ID, when supplied.
trace_unique_id string Optional
Parent trace ID.
span_name string Optional
Span name.
span_parent_id string Optional
Parent span ID.
span_workflow_name string Optional
Workflow name associated with the span.
timestamp string Optional
Completion timestamp.
Format: date-time
start_time string Optional
Start timestamp.
Format: date-time
period_start string Optional
Billing/aggregation period start.
Format: date-time
period_end string Optional
Billing/aggregation period end.
Format: date-time
input string or object or array<any> or number or boolean Optional
Canonical span input.
input (oneOf 1) string Schema variant
-
input (oneOf 2) object Schema variant
Additional properties are allowed
input (oneOf 3) array<any> Schema variant
-
input (oneOf 3)[] any Array item
-
input (oneOf 4) number Schema variant
-
input (oneOf 5) boolean Schema variant
-
output string or object or array<any> or number or boolean Optional
Canonical span output.
output (oneOf 1) string Schema variant
-
output (oneOf 2) object Schema variant
Additional properties are allowed
output (oneOf 3) array<any> Schema variant
-
output (oneOf 3)[] any Array item
-
output (oneOf 4) number Schema variant
-
output (oneOf 5) boolean Schema variant
-
prompt_messages array<object> Optional
-
prompt_messages[] object Array item
Additional properties are allowed
completion_message object Optional
Additional properties are allowed
completion_messages array<any> Optional
-
completion_messages[] any Array item
-
full_request object Optional
Credential-sanitized full request.
Additional properties are allowed
full_response object Optional
Credential-sanitized full response.
Additional properties are allowed
model string Optional
Model used by the span.
provider_id string Optional
Provider route used by the span.
environment string Optional
API-key environment.
log_type string Optional
Span/log type.
log_method string Optional
How this span was ingested.
status string Optional
Span status.
status_code integer Optional
HTTP or application status code.
error_code string Optional
Normalized error code.
Maximum length: 120
error_message string Optional
Error message, when the span failed.
warnings string or object or array<any> or number or boolean Optional
Warnings captured for the request.
warnings (oneOf 1) string Schema variant
-
warnings (oneOf 2) object Schema variant
Additional properties are allowed
warnings (oneOf 3) array<any> Schema variant
-
warnings (oneOf 3)[] any Array item
-
warnings (oneOf 4) number Schema variant
-
warnings (oneOf 5) boolean Schema variant
-
prompt_tokens integer Optional
Input token count.
completion_tokens integer Optional
Output token count.
total_request_tokens integer Optional
Total token count.
prompt_cache_hit_tokens integer Optional
Cached input-token count.
prompt_cache_creation_tokens integer Optional
Cache-creation input-token count.
reasoning_tokens integer Optional
Reasoning-token count.
cost number Optional
Cost in USD.
latency number Optional
End-to-end latency in seconds.
time_to_first_token number Optional
Time to first token in seconds.
tokens_per_second number Optional
Output throughput.
routing_time number Optional
Gateway routing time.
metadata object Optional
Customer metadata. Keys beginning with _ are reserved and omitted from customer-facing responses.
Additional properties are allowed
properties string or object or array<any> or number or boolean Optional
Typed span properties.
properties (oneOf 1) string Schema variant
-
properties (oneOf 2) object Schema variant
Additional properties are allowed
properties (oneOf 3) array<any> Schema variant
-
properties (oneOf 3)[] any Array item
-
properties (oneOf 4) number Schema variant
-
properties (oneOf 5) boolean Schema variant
-
variables object Optional
Additional properties are allowed
tools array<object> Optional
-
tools[] object Array item
Additional properties are allowed
tool_calls array<object> Optional
-
tool_calls[] object Array item
Additional properties are allowed
scores object Optional
Evaluation scores keyed by evaluator identifier or slug.
scores.<key> object Map value
Additional properties are allowed
scores.<key>.id string Optional
-
scores.<key>.evaluator_id string Optional
-
scores.<key>.evaluator_slug string or null Optional
-
scores.<key>.evaluator_name string or null Optional
-
scores.<key>.score_value_type string or null Optional
-
scores.<key>.numerical_value number or null Optional
-
scores.<key>.string_value string or null Optional
-
scores.<key>.boolean_value boolean or null Optional
-
scores.<key>.categorical_value array<string> or null Optional
-
scores.<key>.categorical_value[] string Array item
-
scores.<key>.json_value any or null Optional
-
scores.<key>.is_passed boolean or null Optional
-
scores.<key>.explanation string Optional
-
customer_identifier string Optional
End-customer identifier.
customer_email string Optional
End-customer email.
customer_name string Optional
End-customer name.
custom_identifier string Optional
Indexed custom identifier.
group_identifier string Optional
Group identifier.
session_identifier string Optional
Session identifier.
thread_identifier string Optional
Conversation thread identifier.
organization_id string Optional
Organization UUID.
unique_organization_id string Optional
Organization UUID.
organization_key_id string Optional
API-key identifier.
organization_key_name string Optional
API-key display name.
prompt_id string Optional
Prompt family ID.
prompt_name string Optional
Prompt display name.
prompt_version_number integer Optional
Prompt version number.
deployment_id string Optional
Deployment ID.
deployment_name string Optional
Deployment name.
stream boolean Optional
Whether the response streamed.
temperature number Optional
Sampling temperature.
top_p number Optional
Nucleus-sampling parameter.
max_tokens integer Optional
Configured generation limit.
response_format object Optional
Additional properties are allowed
limit_info object Optional
-
limit_info.is_allowed boolean Optional
-
limit_info.limits array<object> Optional
-
limit_info.limits[] object Array item
-
limit_info.limits[].name string Optional
-
limit_info.limits[].current_value number Optional
-
limit_info.limits[].new_value number Optional
-
limit_info.limits[].limit_value number Optional
-
limit_info.limits[].is_within_limit boolean Optional
-
blurred boolean Optional
When true, usage policy reduced the response to visibility-safe fields.

OpenAPI response schema

{
  "type": "object",
  "description": "Full customer-facing span detail. Additional stored or enrichment fields may be present. For usage-capped records, the server can instead return a reduced object with `blurred: true`.",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Span ID (alias of `unique_id`)."
    },
    "unique_id": {
      "type": "string",
      "description": "Stored unique span ID."
    },
    "span_unique_id": {
      "type": "string",
      "description": "Tracing span ID, when supplied."
    },
    "trace_unique_id": {
      "type": "string",
      "description": "Parent trace ID."
    },
    "span_name": {
      "type": "string",
      "description": "Span name."
    },
    "span_parent_id": {
      "type": "string",
      "description": "Parent span ID."
    },
    "span_workflow_name": {
      "type": "string",
      "description": "Workflow name associated with the span."
    },
    "timestamp": {
      "type": "string",
      "description": "Completion timestamp.",
      "format": "date-time"
    },
    "start_time": {
      "type": "string",
      "description": "Start timestamp.",
      "format": "date-time"
    },
    "period_start": {
      "type": "string",
      "description": "Billing/aggregation period start.",
      "format": "date-time"
    },
    "period_end": {
      "type": "string",
      "description": "Billing/aggregation period end.",
      "format": "date-time"
    },
    "input": {
      "description": "Canonical span input.",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "output": {
      "description": "Canonical span output.",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "prompt_messages": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "completion_message": {
      "type": "object",
      "additionalProperties": true
    },
    "completion_messages": {
      "type": "array",
      "items": {}
    },
    "full_request": {
      "type": "object",
      "additionalProperties": true,
      "description": "Credential-sanitized full request."
    },
    "full_response": {
      "type": "object",
      "additionalProperties": true,
      "description": "Credential-sanitized full response."
    },
    "model": {
      "type": "string",
      "description": "Model used by the span."
    },
    "provider_id": {
      "type": "string",
      "description": "Provider route used by the span."
    },
    "environment": {
      "type": "string",
      "description": "API-key environment."
    },
    "log_type": {
      "type": "string",
      "description": "Span/log type."
    },
    "log_method": {
      "type": "string",
      "description": "How this span was ingested."
    },
    "status": {
      "type": "string",
      "description": "Span status."
    },
    "status_code": {
      "type": "integer",
      "description": "HTTP or application status code."
    },
    "error_code": {
      "type": "string",
      "description": "Normalized error code.",
      "maxLength": 120
    },
    "error_message": {
      "type": "string",
      "description": "Error message, when the span failed."
    },
    "warnings": {
      "description": "Warnings captured for the request.",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "prompt_tokens": {
      "type": "integer",
      "description": "Input token count."
    },
    "completion_tokens": {
      "type": "integer",
      "description": "Output token count."
    },
    "total_request_tokens": {
      "type": "integer",
      "description": "Total token count."
    },
    "prompt_cache_hit_tokens": {
      "type": "integer",
      "description": "Cached input-token count."
    },
    "prompt_cache_creation_tokens": {
      "type": "integer",
      "description": "Cache-creation input-token count."
    },
    "reasoning_tokens": {
      "type": "integer",
      "description": "Reasoning-token count."
    },
    "cost": {
      "type": "number",
      "description": "Cost in USD."
    },
    "latency": {
      "type": "number",
      "description": "End-to-end latency in seconds."
    },
    "time_to_first_token": {
      "type": "number",
      "description": "Time to first token in seconds."
    },
    "tokens_per_second": {
      "type": "number",
      "description": "Output throughput."
    },
    "routing_time": {
      "type": "number",
      "description": "Gateway routing time."
    },
    "metadata": {
      "type": "object",
      "additionalProperties": true,
      "description": "Customer metadata. Keys beginning with `_` are reserved and omitted from customer-facing responses."
    },
    "properties": {
      "description": "Typed span properties.",
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "variables": {
      "type": "object",
      "additionalProperties": true
    },
    "tools": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "tool_calls": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "scores": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "evaluator_id": {
            "type": "string"
          },
          "evaluator_slug": {
            "type": "string",
            "nullable": true
          },
          "evaluator_name": {
            "type": "string",
            "nullable": true
          },
          "score_value_type": {
            "type": "string",
            "nullable": true
          },
          "numerical_value": {
            "type": "number",
            "nullable": true
          },
          "string_value": {
            "type": "string",
            "nullable": true
          },
          "boolean_value": {
            "type": "boolean",
            "nullable": true
          },
          "categorical_value": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "json_value": {
            "nullable": true
          },
          "is_passed": {
            "type": "boolean",
            "nullable": true
          },
          "explanation": {
            "type": "string"
          }
        },
        "additionalProperties": true
      },
      "description": "Evaluation scores keyed by evaluator identifier or slug."
    },
    "customer_identifier": {
      "type": "string",
      "description": "End-customer identifier."
    },
    "customer_email": {
      "type": "string",
      "description": "End-customer email."
    },
    "customer_name": {
      "type": "string",
      "description": "End-customer name."
    },
    "custom_identifier": {
      "type": "string",
      "description": "Indexed custom identifier."
    },
    "group_identifier": {
      "type": "string",
      "description": "Group identifier."
    },
    "session_identifier": {
      "type": "string",
      "description": "Session identifier."
    },
    "thread_identifier": {
      "type": "string",
      "description": "Conversation thread identifier."
    },
    "organization_id": {
      "type": "string",
      "description": "Organization UUID."
    },
    "unique_organization_id": {
      "type": "string",
      "description": "Organization UUID."
    },
    "organization_key_id": {
      "type": "string",
      "description": "API-key identifier."
    },
    "organization_key_name": {
      "type": "string",
      "description": "API-key display name."
    },
    "prompt_id": {
      "type": "string",
      "description": "Prompt family ID."
    },
    "prompt_name": {
      "type": "string",
      "description": "Prompt display name."
    },
    "prompt_version_number": {
      "type": "integer",
      "description": "Prompt version number."
    },
    "deployment_id": {
      "type": "string",
      "description": "Deployment ID."
    },
    "deployment_name": {
      "type": "string",
      "description": "Deployment name."
    },
    "stream": {
      "type": "boolean",
      "description": "Whether the response streamed."
    },
    "temperature": {
      "type": "number",
      "description": "Sampling temperature."
    },
    "top_p": {
      "type": "number",
      "description": "Nucleus-sampling parameter."
    },
    "max_tokens": {
      "type": "integer",
      "description": "Configured generation limit."
    },
    "response_format": {
      "type": "object",
      "additionalProperties": true
    },
    "limit_info": {
      "type": "object",
      "properties": {
        "is_allowed": {
          "type": "boolean"
        },
        "limits": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "current_value": {
                "type": "number"
              },
              "new_value": {
                "type": "number"
              },
              "limit_value": {
                "type": "number"
              },
              "is_within_limit": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "blurred": {
      "type": "boolean",
      "description": "When true, usage policy reduced the response to visibility-safe fields."
    }
  },
  "additionalProperties": true
}
Example
JSON
{ "limit_info": { "is_allowed": true, "limits": [ { "name": "org_credits", "current_value": 29.99, "new_value": 29.98, "limit_value": 0, "is_within_limit": true }, { "name": "customer_budget", "current_value": 8.5, "new_value": 8.49, "limit_value": 10, "is_within_limit": true } ] }, "id": "span_550e8400e29b41d4" }

400

Bad Request

application/json

Field Type Requirement Description and constraints
$ object Body
-
error string Optional
Error message
Example: "Invalid request body"

OpenAPI response schema

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Error message",
      "example": "Invalid request body"
    }
  }
}

403

The API key is missing, invalid or expired.

application/json

Field Type Requirement Description and constraints
$ object Body
-
detail string Required in parent
-

OpenAPI response schema

{
  "type": "object",
  "required": [
    "detail"
  ],
  "properties": {
    "detail": {
      "type": "string"
    }
  }
}
Example
JSON
{ "detail": "Your API key is invalid or expired, please check your API key in the platform settings." }

404

Span not found.

application/json

Field Type Requirement Description and constraints
$ object Body
-
detail string Required in parent
-

OpenAPI response schema

{
  "type": "object",
  "required": [
    "detail"
  ],
  "properties": {
    "detail": {
      "type": "string"
    }
  }
}
Example
JSON
{ "detail": "Log not found in storage" }

429

Rate Limited

application/json

Field Type Requirement Description and constraints
$ object Body
-
error string Optional
Error message
Example: "Rate limit exceeded"

OpenAPI response schema

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Error message",
      "example": "Rate limit exceeded"
    }
  }
}

500

Internal Server Error

application/json

Field Type Requirement Description and constraints
$ object Body
-
error string Optional
Error message
Example: "Internal server error"

OpenAPI response schema

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Error message",
      "example": "Internal server error"
    }
  }
}

OpenAPI source

The operation and referenced components below retain the complete OpenAPI definitions, including constraints and examples.

OpenAPI operation

{
  "summary": "Get a span",
  "operationId": "retrieveSpan",
  "tags": [
    "Spans"
  ],
  "description": "Returns the full span, including evaluation scores and credit and budget information (`limit_info`). Metadata keys beginning with `_` are reserved for platform use and omitted from span and trace read responses.",
  "parameters": [
    {
      "name": "unique_id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string"
      },
      "description": "The unique ID of the log to get."
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response for Retrieve span",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "description": "Full customer-facing span detail. Additional stored or enrichment fields may be present. For usage-capped records, the server can instead return a reduced object with `blurred: true`.",
            "required": [
              "id"
            ],
            "properties": {
              "id": {
                "type": "string",
                "description": "Span ID (alias of `unique_id`)."
              },
              "unique_id": {
                "type": "string",
                "description": "Stored unique span ID."
              },
              "span_unique_id": {
                "type": "string",
                "description": "Tracing span ID, when supplied."
              },
              "trace_unique_id": {
                "type": "string",
                "description": "Parent trace ID."
              },
              "span_name": {
                "type": "string",
                "description": "Span name."
              },
              "span_parent_id": {
                "type": "string",
                "description": "Parent span ID."
              },
              "span_workflow_name": {
                "type": "string",
                "description": "Workflow name associated with the span."
              },
              "timestamp": {
                "type": "string",
                "description": "Completion timestamp.",
                "format": "date-time"
              },
              "start_time": {
                "type": "string",
                "description": "Start timestamp.",
                "format": "date-time"
              },
              "period_start": {
                "type": "string",
                "description": "Billing/aggregation period start.",
                "format": "date-time"
              },
              "period_end": {
                "type": "string",
                "description": "Billing/aggregation period end.",
                "format": "date-time"
              },
              "input": {
                "description": "Canonical span input.",
                "oneOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "object",
                    "additionalProperties": true
                  },
                  {
                    "type": "array",
                    "items": {}
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "boolean"
                  }
                ]
              },
              "output": {
                "description": "Canonical span output.",
                "oneOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "object",
                    "additionalProperties": true
                  },
                  {
                    "type": "array",
                    "items": {}
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "boolean"
                  }
                ]
              },
              "prompt_messages": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": true
                }
              },
              "completion_message": {
                "type": "object",
                "additionalProperties": true
              },
              "completion_messages": {
                "type": "array",
                "items": {}
              },
              "full_request": {
                "type": "object",
                "additionalProperties": true,
                "description": "Credential-sanitized full request."
              },
              "full_response": {
                "type": "object",
                "additionalProperties": true,
                "description": "Credential-sanitized full response."
              },
              "model": {
                "type": "string",
                "description": "Model used by the span."
              },
              "provider_id": {
                "type": "string",
                "description": "Provider route used by the span."
              },
              "environment": {
                "type": "string",
                "description": "API-key environment."
              },
              "log_type": {
                "type": "string",
                "description": "Span/log type."
              },
              "log_method": {
                "type": "string",
                "description": "How this span was ingested."
              },
              "status": {
                "type": "string",
                "description": "Span status."
              },
              "status_code": {
                "type": "integer",
                "description": "HTTP or application status code."
              },
              "error_code": {
                "type": "string",
                "description": "Normalized error code.",
                "maxLength": 120
              },
              "error_message": {
                "type": "string",
                "description": "Error message, when the span failed."
              },
              "warnings": {
                "description": "Warnings captured for the request.",
                "oneOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "object",
                    "additionalProperties": true
                  },
                  {
                    "type": "array",
                    "items": {}
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "boolean"
                  }
                ]
              },
              "prompt_tokens": {
                "type": "integer",
                "description": "Input token count."
              },
              "completion_tokens": {
                "type": "integer",
                "description": "Output token count."
              },
              "total_request_tokens": {
                "type": "integer",
                "description": "Total token count."
              },
              "prompt_cache_hit_tokens": {
                "type": "integer",
                "description": "Cached input-token count."
              },
              "prompt_cache_creation_tokens": {
                "type": "integer",
                "description": "Cache-creation input-token count."
              },
              "reasoning_tokens": {
                "type": "integer",
                "description": "Reasoning-token count."
              },
              "cost": {
                "type": "number",
                "description": "Cost in USD."
              },
              "latency": {
                "type": "number",
                "description": "End-to-end latency in seconds."
              },
              "time_to_first_token": {
                "type": "number",
                "description": "Time to first token in seconds."
              },
              "tokens_per_second": {
                "type": "number",
                "description": "Output throughput."
              },
              "routing_time": {
                "type": "number",
                "description": "Gateway routing time."
              },
              "metadata": {
                "type": "object",
                "additionalProperties": true,
                "description": "Customer metadata. Keys beginning with `_` are reserved and omitted from customer-facing responses."
              },
              "properties": {
                "description": "Typed span properties.",
                "oneOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "object",
                    "additionalProperties": true
                  },
                  {
                    "type": "array",
                    "items": {}
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "boolean"
                  }
                ]
              },
              "variables": {
                "type": "object",
                "additionalProperties": true
              },
              "tools": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": true
                }
              },
              "tool_calls": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": true
                }
              },
              "scores": {
                "type": "object",
                "additionalProperties": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "evaluator_id": {
                      "type": "string"
                    },
                    "evaluator_slug": {
                      "type": "string",
                      "nullable": true
                    },
                    "evaluator_name": {
                      "type": "string",
                      "nullable": true
                    },
                    "score_value_type": {
                      "type": "string",
                      "nullable": true
                    },
                    "numerical_value": {
                      "type": "number",
                      "nullable": true
                    },
                    "string_value": {
                      "type": "string",
                      "nullable": true
                    },
                    "boolean_value": {
                      "type": "boolean",
                      "nullable": true
                    },
                    "categorical_value": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "nullable": true
                    },
                    "json_value": {
                      "nullable": true
                    },
                    "is_passed": {
                      "type": "boolean",
                      "nullable": true
                    },
                    "explanation": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": true
                },
                "description": "Evaluation scores keyed by evaluator identifier or slug."
              },
              "customer_identifier": {
                "type": "string",
                "description": "End-customer identifier."
              },
              "customer_email": {
                "type": "string",
                "description": "End-customer email."
              },
              "customer_name": {
                "type": "string",
                "description": "End-customer name."
              },
              "custom_identifier": {
                "type": "string",
                "description": "Indexed custom identifier."
              },
              "group_identifier": {
                "type": "string",
                "description": "Group identifier."
              },
              "session_identifier": {
                "type": "string",
                "description": "Session identifier."
              },
              "thread_identifier": {
                "type": "string",
                "description": "Conversation thread identifier."
              },
              "organization_id": {
                "type": "string",
                "description": "Organization UUID."
              },
              "unique_organization_id": {
                "type": "string",
                "description": "Organization UUID."
              },
              "organization_key_id": {
                "type": "string",
                "description": "API-key identifier."
              },
              "organization_key_name": {
                "type": "string",
                "description": "API-key display name."
              },
              "prompt_id": {
                "type": "string",
                "description": "Prompt family ID."
              },
              "prompt_name": {
                "type": "string",
                "description": "Prompt display name."
              },
              "prompt_version_number": {
                "type": "integer",
                "description": "Prompt version number."
              },
              "deployment_id": {
                "type": "string",
                "description": "Deployment ID."
              },
              "deployment_name": {
                "type": "string",
                "description": "Deployment name."
              },
              "stream": {
                "type": "boolean",
                "description": "Whether the response streamed."
              },
              "temperature": {
                "type": "number",
                "description": "Sampling temperature."
              },
              "top_p": {
                "type": "number",
                "description": "Nucleus-sampling parameter."
              },
              "max_tokens": {
                "type": "integer",
                "description": "Configured generation limit."
              },
              "response_format": {
                "type": "object",
                "additionalProperties": true
              },
              "limit_info": {
                "type": "object",
                "properties": {
                  "is_allowed": {
                    "type": "boolean"
                  },
                  "limits": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string"
                        },
                        "current_value": {
                          "type": "number"
                        },
                        "new_value": {
                          "type": "number"
                        },
                        "limit_value": {
                          "type": "number"
                        },
                        "is_within_limit": {
                          "type": "boolean"
                        }
                      }
                    }
                  }
                }
              },
              "blurred": {
                "type": "boolean",
                "description": "When true, usage policy reduced the response to visibility-safe fields."
              }
            },
            "additionalProperties": true
          },
          "example": {
            "limit_info": {
              "is_allowed": true,
              "limits": [
                {
                  "name": "org_credits",
                  "current_value": 29.99,
                  "new_value": 29.98,
                  "limit_value": 0,
                  "is_within_limit": true
                },
                {
                  "name": "customer_budget",
                  "current_value": 8.5,
                  "new_value": 8.49,
                  "limit_value": 10,
                  "is_within_limit": true
                }
              ]
            },
            "id": "span_550e8400e29b41d4"
          }
        }
      }
    },
    "400": {
      "description": "Bad Request",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Error message",
                "example": "Invalid request body"
              }
            }
          }
        }
      }
    },
    "403": {
      "$ref": "#/components/responses/InvalidApiKey"
    },
    "404": {
      "description": "Span not found.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "detail"
            ],
            "properties": {
              "detail": {
                "type": "string"
              }
            }
          },
          "example": {
            "detail": "Log not found in storage"
          }
        }
      }
    },
    "429": {
      "description": "Rate Limited",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Error message",
                "example": "Rate limit exceeded"
              }
            }
          }
        }
      }
    },
    "500": {
      "description": "Internal Server Error",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "error": {
                "type": "string",
                "description": "Error message",
                "example": "Internal server error"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "RespanApiKey": []
    },
    {
      "DashboardJwt": []
    }
  ]
}

OpenAPI path metadata

{}

Referenced OpenAPI components

{
  "responses": {
    "InvalidApiKey": {
      "description": "The API key is missing, invalid or expired.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "detail"
            ],
            "properties": {
              "detail": {
                "type": "string"
              }
            }
          },
          "example": {
            "detail": "Your API key is invalid or expired, please check your API key in the platform settings."
          }
        }
      }
    }
  },
  "securitySchemes": {
    "DashboardJwt": {
      "type": "http",
      "scheme": "bearer",
      "bearerFormat": "Dashboard JWT",
      "description": "Use a dashboard JWT only for dashboard-authenticated endpoints. Respan API-key endpoints use the respanApiKey auth field instead.",
      "x-fern-bearer": {
        "name": "dashboardJwt",
        "env": "RESPAN_DASHBOARD_JWT"
      }
    },
    "RespanApiKey": {
      "type": "http",
      "scheme": "bearer",
      "bearerFormat": "Respan API key",
      "description": "Use your Respan API key for Respan API authentication. Enter only the Respan API key value; clients send Authorization: Bearer <RESPAN_API_KEY>. For /api/responses, provider credentials such as Perplexity, OpenAI, or Azure OpenAI go in Settings -> Providers or respan_params.credential_override in the request body, not in this authentication field.",
      "x-fern-bearer": {
        "name": "respanApiKey",
        "env": "RESPAN_API_KEY"
      }
    }
  }
}