{ "opencollection": "1.0.0", "info": { "name": "Arthur GenAI Engine Agent Discovery Spans API", "version": "2.1.688" }, "items": [ { "info": { "name": "Spans", "type": "folder" }, "items": [ { "info": { "name": "Query Traces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/traces/query", "params": [ { "name": "sort_by", "value": "", "type": "query", "description": "Column to sort results by." }, { "name": "sort", "value": "", "type": "query", "description": "Sort the results (asc/desc)" }, { "name": "page_size", "value": "", "type": "query", "description": "Page size. Default is 10. Must be greater than 0 and less than 5000." }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "task_ids", "value": "", "type": "query", "description": "Task IDs to filter on. At least one is required." }, { "name": "trace_ids", "value": "", "type": "query", "description": "Trace IDs to filter on. Optional." }, { "name": "start_time", "value": "", "type": "query", "description": "Inclusive start date in ISO8601 string format. Use local time (not UTC)." }, { "name": "end_time", "value": "", "type": "query", "description": "Exclusive end date in ISO8601 string format. Use local time (not UTC)." }, { "name": "tool_name", "value": "", "type": "query", "description": "Return only results with this tool name." }, { "name": "span_types", "value": "", "type": "query", "description": "Span types to filter on. Optional. Valid values: AGENT, CHAIN, EMBEDDING, EVALUATOR, GUARDRAIL, LLM, PROMPT, RERANKER, RETRIEVER, TOOL, UNKNOWN" }, { "name": "annotation_score", "value": "", "type": "query", "description": "Filter by trace annotation score (0 or 1)." }, { "name": "annotation_type", "value": "", "type": "query", "description": "Filter by trace annotation type (i.e. 'human' or 'continuous_eval')." }, { "name": "continuous_eval_run_status", "value": "", "type": "query", "description": "Filter by trace annotation run status (e.g. 'passed', 'failed', etc.)." }, { "name": "continuous_eval_name", "value": "", "type": "query", "description": "Filter by continuous eval name." }, { "name": "span_ids", "value": "", "type": "query", "description": "Span IDs to filter on. Optional." }, { "name": "session_ids", "value": "", "type": "query", "description": "Session IDs to filter on. Optional." }, { "name": "user_ids", "value": "", "type": "query", "description": "User ID substrings to filter on (case-insensitive). Returns results where user_id contains any of the provided values. Optional." }, { "name": "span_name", "value": "", "type": "query", "description": "Return only results with this span name." }, { "name": "span_name_contains", "value": "", "type": "query", "description": "Return only results where span name contains this substring." }, { "name": "status_code", "value": "", "type": "query", "description": "Status codes to filter on. Optional. Valid values: Ok, Error, Unset." }, { "name": "query_relevance_eq", "value": "", "type": "query", "description": "Equal to this value." }, { "name": "query_relevance_gt", "value": "", "type": "query", "description": "Greater than this value." }, { "name": "query_relevance_gte", "value": "", "type": "query", "description": "Greater than or equal to this value." }, { "name": "query_relevance_lt", "value": "", "type": "query", "description": "Less than this value." }, { "name": "query_relevance_lte", "value": "", "type": "query", "description": "Less than or equal to this value." }, { "name": "response_relevance_eq", "value": "", "type": "query", "description": "Equal to this value." }, { "name": "response_relevance_gt", "value": "", "type": "query", "description": "Greater than this value." }, { "name": "response_relevance_gte", "value": "", "type": "query", "description": "Greater than or equal to this value." }, { "name": "response_relevance_lt", "value": "", "type": "query", "description": "Less than this value." }, { "name": "response_relevance_lte", "value": "", "type": "query", "description": "Less than or equal to this value." }, { "name": "tool_selection", "value": "", "type": "query", "description": "Tool selection evaluation result." }, { "name": "tool_usage", "value": "", "type": "query", "description": "Tool usage evaluation result." }, { "name": "trace_duration_eq", "value": "", "type": "query", "description": "Duration exactly equal to this value (seconds)." }, { "name": "trace_duration_gt", "value": "", "type": "query", "description": "Duration greater than this value (seconds)." }, { "name": "trace_duration_gte", "value": "", "type": "query", "description": "Duration greater than or equal to this value (seconds)." }, { "name": "trace_duration_lt", "value": "", "type": "query", "description": "Duration less than this value (seconds)." }, { "name": "trace_duration_lte", "value": "", "type": "query", "description": "Duration less than or equal to this value (seconds)." }, { "name": "total_token_count_eq", "value": "", "type": "query", "description": "Total token count exactly equal to this value." }, { "name": "total_token_count_gt", "value": "", "type": "query", "description": "Total token count greater than this value." }, { "name": "total_token_count_gte", "value": "", "type": "query", "description": "Total token count greater than or equal to this value." }, { "name": "total_token_count_lt", "value": "", "type": "query", "description": "Total token count less than this value." }, { "name": "total_token_count_lte", "value": "", "type": "query", "description": "Total token count less than or equal to this value." }, { "name": "prompt_token_count_eq", "value": "", "type": "query", "description": "Prompt token count exactly equal to this value." }, { "name": "prompt_token_count_gt", "value": "", "type": "query", "description": "Prompt token count greater than this value." }, { "name": "prompt_token_count_gte", "value": "", "type": "query", "description": "Prompt token count greater than or equal to this value." }, { "name": "prompt_token_count_lt", "value": "", "type": "query", "description": "Prompt token count less than this value." }, { "name": "prompt_token_count_lte", "value": "", "type": "query", "description": "Prompt token count less than or equal to this value." }, { "name": "completion_token_count_eq", "value": "", "type": "query", "description": "Completion token count exactly equal to this value." }, { "name": "completion_token_count_gt", "value": "", "type": "query", "description": "Completion token count greater than this value." }, { "name": "completion_token_count_gte", "value": "", "type": "query", "description": "Completion token count greater than or equal to this value." }, { "name": "completion_token_count_lt", "value": "", "type": "query", "description": "Completion token count less than this value." }, { "name": "completion_token_count_lte", "value": "", "type": "query", "description": "Completion token count less than or equal to this value." }, { "name": "span_count_eq", "value": "", "type": "query", "description": "Span count exactly equal to this value." }, { "name": "span_count_gt", "value": "", "type": "query", "description": "Span count greater than this value." }, { "name": "span_count_gte", "value": "", "type": "query", "description": "Span count greater than or equal to this value." }, { "name": "span_count_lt", "value": "", "type": "query", "description": "Span count less than this value." }, { "name": "span_count_lte", "value": "", "type": "query", "description": "Span count less than or equal to this value." }, { "name": "include_experiment_traces", "value": "", "type": "query", "description": "Include traces originating from Arthur experiments. Defaults to true." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Query traces with comprehensive filtering. Returns traces containing spans that match the filters, not just the spans themselves." }, { "info": { "name": "Compute Missing Metrics and Query Traces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/traces/metrics/", "params": [ { "name": "sort_by", "value": "", "type": "query", "description": "Column to sort results by." }, { "name": "sort", "value": "", "type": "query", "description": "Sort the results (asc/desc)" }, { "name": "page_size", "value": "", "type": "query", "description": "Page size. Default is 10. Must be greater than 0 and less than 5000." }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "task_ids", "value": "", "type": "query", "description": "Task IDs to filter on. At least one is required." }, { "name": "trace_ids", "value": "", "type": "query", "description": "Trace IDs to filter on. Optional." }, { "name": "start_time", "value": "", "type": "query", "description": "Inclusive start date in ISO8601 string format. Use local time (not UTC)." }, { "name": "end_time", "value": "", "type": "query", "description": "Exclusive end date in ISO8601 string format. Use local time (not UTC)." }, { "name": "tool_name", "value": "", "type": "query", "description": "Return only results with this tool name." }, { "name": "span_types", "value": "", "type": "query", "description": "Span types to filter on. Optional. Valid values: AGENT, CHAIN, EMBEDDING, EVALUATOR, GUARDRAIL, LLM, PROMPT, RERANKER, RETRIEVER, TOOL, UNKNOWN" }, { "name": "annotation_score", "value": "", "type": "query", "description": "Filter by trace annotation score (0 or 1)." }, { "name": "annotation_type", "value": "", "type": "query", "description": "Filter by trace annotation type (i.e. 'human' or 'continuous_eval')." }, { "name": "continuous_eval_run_status", "value": "", "type": "query", "description": "Filter by trace annotation run status (e.g. 'passed', 'failed', etc.)." }, { "name": "continuous_eval_name", "value": "", "type": "query", "description": "Filter by continuous eval name." }, { "name": "span_ids", "value": "", "type": "query", "description": "Span IDs to filter on. Optional." }, { "name": "session_ids", "value": "", "type": "query", "description": "Session IDs to filter on. Optional." }, { "name": "user_ids", "value": "", "type": "query", "description": "User ID substrings to filter on (case-insensitive). Returns results where user_id contains any of the provided values. Optional." }, { "name": "span_name", "value": "", "type": "query", "description": "Return only results with this span name." }, { "name": "span_name_contains", "value": "", "type": "query", "description": "Return only results where span name contains this substring." }, { "name": "status_code", "value": "", "type": "query", "description": "Status codes to filter on. Optional. Valid values: Ok, Error, Unset." }, { "name": "query_relevance_eq", "value": "", "type": "query", "description": "Equal to this value." }, { "name": "query_relevance_gt", "value": "", "type": "query", "description": "Greater than this value." }, { "name": "query_relevance_gte", "value": "", "type": "query", "description": "Greater than or equal to this value." }, { "name": "query_relevance_lt", "value": "", "type": "query", "description": "Less than this value." }, { "name": "query_relevance_lte", "value": "", "type": "query", "description": "Less than or equal to this value." }, { "name": "response_relevance_eq", "value": "", "type": "query", "description": "Equal to this value." }, { "name": "response_relevance_gt", "value": "", "type": "query", "description": "Greater than this value." }, { "name": "response_relevance_gte", "value": "", "type": "query", "description": "Greater than or equal to this value." }, { "name": "response_relevance_lt", "value": "", "type": "query", "description": "Less than this value." }, { "name": "response_relevance_lte", "value": "", "type": "query", "description": "Less than or equal to this value." }, { "name": "tool_selection", "value": "", "type": "query", "description": "Tool selection evaluation result." }, { "name": "tool_usage", "value": "", "type": "query", "description": "Tool usage evaluation result." }, { "name": "trace_duration_eq", "value": "", "type": "query", "description": "Duration exactly equal to this value (seconds)." }, { "name": "trace_duration_gt", "value": "", "type": "query", "description": "Duration greater than this value (seconds)." }, { "name": "trace_duration_gte", "value": "", "type": "query", "description": "Duration greater than or equal to this value (seconds)." }, { "name": "trace_duration_lt", "value": "", "type": "query", "description": "Duration less than this value (seconds)." }, { "name": "trace_duration_lte", "value": "", "type": "query", "description": "Duration less than or equal to this value (seconds)." }, { "name": "total_token_count_eq", "value": "", "type": "query", "description": "Total token count exactly equal to this value." }, { "name": "total_token_count_gt", "value": "", "type": "query", "description": "Total token count greater than this value." }, { "name": "total_token_count_gte", "value": "", "type": "query", "description": "Total token count greater than or equal to this value." }, { "name": "total_token_count_lt", "value": "", "type": "query", "description": "Total token count less than this value." }, { "name": "total_token_count_lte", "value": "", "type": "query", "description": "Total token count less than or equal to this value." }, { "name": "prompt_token_count_eq", "value": "", "type": "query", "description": "Prompt token count exactly equal to this value." }, { "name": "prompt_token_count_gt", "value": "", "type": "query", "description": "Prompt token count greater than this value." }, { "name": "prompt_token_count_gte", "value": "", "type": "query", "description": "Prompt token count greater than or equal to this value." }, { "name": "prompt_token_count_lt", "value": "", "type": "query", "description": "Prompt token count less than this value." }, { "name": "prompt_token_count_lte", "value": "", "type": "query", "description": "Prompt token count less than or equal to this value." }, { "name": "completion_token_count_eq", "value": "", "type": "query", "description": "Completion token count exactly equal to this value." }, { "name": "completion_token_count_gt", "value": "", "type": "query", "description": "Completion token count greater than this value." }, { "name": "completion_token_count_gte", "value": "", "type": "query", "description": "Completion token count greater than or equal to this value." }, { "name": "completion_token_count_lt", "value": "", "type": "query", "description": "Completion token count less than this value." }, { "name": "completion_token_count_lte", "value": "", "type": "query", "description": "Completion token count less than or equal to this value." }, { "name": "span_count_eq", "value": "", "type": "query", "description": "Span count exactly equal to this value." }, { "name": "span_count_gt", "value": "", "type": "query", "description": "Span count greater than this value." }, { "name": "span_count_gte", "value": "", "type": "query", "description": "Span count greater than or equal to this value." }, { "name": "span_count_lt", "value": "", "type": "query", "description": "Span count less than this value." }, { "name": "span_count_lte", "value": "", "type": "query", "description": "Span count less than or equal to this value." }, { "name": "include_experiment_traces", "value": "", "type": "query", "description": "Include traces originating from Arthur experiments. Defaults to true." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Query traces with comprehensive filtering and compute metrics. Returns traces containing spans that match the filters with computed metrics." }, { "info": { "name": "Query Spans By Type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/spans/query", "params": [ { "name": "task_ids", "value": "", "type": "query", "description": "Task IDs to filter on. At least one is required." }, { "name": "span_types", "value": "", "type": "query", "description": "Span types to filter on. Optional. Valid values: AGENT, CHAIN, EMBEDDING, EVALUATOR, GUARDRAIL, LLM, PROMPT, RERANKER, RETRIEVER, TOOL, UNKNOWN" }, { "name": "start_time", "value": "", "type": "query", "description": "Inclusive start date in ISO8601 string format. Use local time (not UTC)." }, { "name": "end_time", "value": "", "type": "query", "description": "Exclusive end date in ISO8601 string format. Use local time (not UTC)." }, { "name": "sort", "value": "", "type": "query", "description": "Sort the results (asc/desc)" }, { "name": "page_size", "value": "", "type": "query", "description": "Page size. Default is 10. Must be greater than 0 and less than 5000." }, { "name": "page", "value": "", "type": "query", "description": "Page number" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Query spans filtered by span type. Task IDs are required. Returns spans with any existing metrics but does not compute new ones." }, { "info": { "name": "Compute Metrics for Span", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/span/:span_id/metrics", "params": [ { "name": "span_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Compute metrics for a single span. Validates that the span is an LLM span." }, { "info": { "name": "List Span Metadata with Filtering", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/traces/spans", "params": [ { "name": "sort_by", "value": "", "type": "query", "description": "Column to sort results by." }, { "name": "sort", "value": "", "type": "query", "description": "Sort the results (asc/desc)" }, { "name": "page_size", "value": "", "type": "query", "description": "Page size. Default is 10. Must be greater than 0 and less than 5000." }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "task_ids", "value": "", "type": "query", "description": "Task IDs to filter on. At least one is required." }, { "name": "trace_ids", "value": "", "type": "query", "description": "Trace IDs to filter on. Optional." }, { "name": "start_time", "value": "", "type": "query", "description": "Inclusive start date in ISO8601 string format. Use local time (not UTC)." }, { "name": "end_time", "value": "", "type": "query", "description": "Exclusive end date in ISO8601 string format. Use local time (not UTC)." }, { "name": "tool_name", "value": "", "type": "query", "description": "Return only results with this tool name." }, { "name": "span_types", "value": "", "type": "query", "description": "Span types to filter on. Optional. Valid values: AGENT, CHAIN, EMBEDDING, EVALUATOR, GUARDRAIL, LLM, PROMPT, RERANKER, RETRIEVER, TOOL, UNKNOWN" }, { "name": "annotation_score", "value": "", "type": "query", "description": "Filter by trace annotation score (0 or 1)." }, { "name": "annotation_type", "value": "", "type": "query", "description": "Filter by trace annotation type (i.e. 'human' or 'continuous_eval')." }, { "name": "continuous_eval_run_status", "value": "", "type": "query", "description": "Filter by trace annotation run status (e.g. 'passed', 'failed', etc.)." }, { "name": "continuous_eval_name", "value": "", "type": "query", "description": "Filter by continuous eval name." }, { "name": "span_ids", "value": "", "type": "query", "description": "Span IDs to filter on. Optional." }, { "name": "session_ids", "value": "", "type": "query", "description": "Session IDs to filter on. Optional." }, { "name": "user_ids", "value": "", "type": "query", "description": "User ID substrings to filter on (case-insensitive). Returns results where user_id contains any of the provided values. Optional." }, { "name": "span_name", "value": "", "type": "query", "description": "Return only results with this span name." }, { "name": "span_name_contains", "value": "", "type": "query", "description": "Return only results where span name contains this substring." }, { "name": "status_code", "value": "", "type": "query", "description": "Status codes to filter on. Optional. Valid values: Ok, Error, Unset." }, { "name": "query_relevance_eq", "value": "", "type": "query", "description": "Equal to this value." }, { "name": "query_relevance_gt", "value": "", "type": "query", "description": "Greater than this value." }, { "name": "query_relevance_gte", "value": "", "type": "query", "description": "Greater than or equal to this value." }, { "name": "query_relevance_lt", "value": "", "type": "query", "description": "Less than this value." }, { "name": "query_relevance_lte", "value": "", "type": "query", "description": "Less than or equal to this value." }, { "name": "response_relevance_eq", "value": "", "type": "query", "description": "Equal to this value." }, { "name": "response_relevance_gt", "value": "", "type": "query", "description": "Greater than this value." }, { "name": "response_relevance_gte", "value": "", "type": "query", "description": "Greater than or equal to this value." }, { "name": "response_relevance_lt", "value": "", "type": "query", "description": "Less than this value." }, { "name": "response_relevance_lte", "value": "", "type": "query", "description": "Less than or equal to this value." }, { "name": "tool_selection", "value": "", "type": "query", "description": "Tool selection evaluation result." }, { "name": "tool_usage", "value": "", "type": "query", "description": "Tool usage evaluation result." }, { "name": "trace_duration_eq", "value": "", "type": "query", "description": "Duration exactly equal to this value (seconds)." }, { "name": "trace_duration_gt", "value": "", "type": "query", "description": "Duration greater than this value (seconds)." }, { "name": "trace_duration_gte", "value": "", "type": "query", "description": "Duration greater than or equal to this value (seconds)." }, { "name": "trace_duration_lt", "value": "", "type": "query", "description": "Duration less than this value (seconds)." }, { "name": "trace_duration_lte", "value": "", "type": "query", "description": "Duration less than or equal to this value (seconds)." }, { "name": "total_token_count_eq", "value": "", "type": "query", "description": "Total token count exactly equal to this value." }, { "name": "total_token_count_gt", "value": "", "type": "query", "description": "Total token count greater than this value." }, { "name": "total_token_count_gte", "value": "", "type": "query", "description": "Total token count greater than or equal to this value." }, { "name": "total_token_count_lt", "value": "", "type": "query", "description": "Total token count less than this value." }, { "name": "total_token_count_lte", "value": "", "type": "query", "description": "Total token count less than or equal to this value." }, { "name": "prompt_token_count_eq", "value": "", "type": "query", "description": "Prompt token count exactly equal to this value." }, { "name": "prompt_token_count_gt", "value": "", "type": "query", "description": "Prompt token count greater than this value." }, { "name": "prompt_token_count_gte", "value": "", "type": "query", "description": "Prompt token count greater than or equal to this value." }, { "name": "prompt_token_count_lt", "value": "", "type": "query", "description": "Prompt token count less than this value." }, { "name": "prompt_token_count_lte", "value": "", "type": "query", "description": "Prompt token count less than or equal to this value." }, { "name": "completion_token_count_eq", "value": "", "type": "query", "description": "Completion token count exactly equal to this value." }, { "name": "completion_token_count_gt", "value": "", "type": "query", "description": "Completion token count greater than this value." }, { "name": "completion_token_count_gte", "value": "", "type": "query", "description": "Completion token count greater than or equal to this value." }, { "name": "completion_token_count_lt", "value": "", "type": "query", "description": "Completion token count less than this value." }, { "name": "completion_token_count_lte", "value": "", "type": "query", "description": "Completion token count less than or equal to this value." }, { "name": "span_count_eq", "value": "", "type": "query", "description": "Span count exactly equal to this value." }, { "name": "span_count_gt", "value": "", "type": "query", "description": "Span count greater than this value." }, { "name": "span_count_gte", "value": "", "type": "query", "description": "Span count greater than or equal to this value." }, { "name": "span_count_lt", "value": "", "type": "query", "description": "Span count less than this value." }, { "name": "span_count_lte", "value": "", "type": "query", "description": "Span count less than or equal to this value." }, { "name": "include_experiment_traces", "value": "", "type": "query", "description": "Include traces originating from Arthur experiments. Defaults to true." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get lightweight span metadata with comprehensive filtering support. Returns individual spans that match filtering criteria with the same filtering capabilities as trace filtering. Supports trace-level filters, span-level filters, and metric filters." }, { "info": { "name": "Get Unregistered Root Spans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/traces/spans/unregistered", "params": [ { "name": "start_time", "value": "", "type": "query", "description": "Inclusive start date in ISO8601 string format. Use local time (not UTC)." }, { "name": "end_time", "value": "", "type": "query", "description": "Inclusive end date in ISO8601 string format. Use local time (not UTC)." }, { "name": "sort", "value": "", "type": "query", "description": "Sort the results (asc/desc)" }, { "name": "page_size", "value": "", "type": "query", "description": "Page size. Default is 10. Must be greater than 0 and less than 5000." }, { "name": "page", "value": "", "type": "query", "description": "Page number" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get grouped root spans for traces without task_id. Groups are ordered by count descending. Supports pagination. Time bounds (start_time/end_time) are recommended for performance on large datasets." }, { "info": { "name": "Get Single Span", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/traces/spans/:span_id", "params": [ { "name": "span_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get single span with existing metrics (no computation). Returns full span object with any existing metrics." }, { "info": { "name": "Compute Missing Span Metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/traces/spans/:span_id/metrics", "params": [ { "name": "span_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Compute all missing metrics for a single span on-demand. Returns span with computed metrics." } ] } ], "bundled": true }