ArthurAI Users API
The Users API from ArthurAI — 2 operation(s) for users.
OpenAPI Specification
openapi: 3.1.0
info:
title: Arthur GenAI Engine Agent Discovery Users API
version: 2.1.688
tags:
- name: Users
paths:
/api/v1/traces/users:
get:
tags:
- Users
summary: List User Metadata
description: Get user metadata with pagination and filtering. Returns aggregated user information across sessions and traces.
operationId: list_users_metadata_api_v1_traces_users_get
security:
- API Key: []
parameters:
- name: task_ids
in: query
required: true
schema:
type: array
items:
type: string
minItems: 1
description: Task IDs to filter on. At least one is required.
title: Task Ids
description: Task IDs to filter on. At least one is required.
- name: start_time
in: query
required: false
schema:
type: string
format: date-time
description: Inclusive start date in ISO8601 string format. Use local time (not UTC).
title: Start Time
description: Inclusive start date in ISO8601 string format. Use local time (not UTC).
- name: end_time
in: query
required: false
schema:
type: string
format: date-time
description: Exclusive end date in ISO8601 string format. Use local time (not UTC).
title: End Time
description: Exclusive end date in ISO8601 string format. Use local time (not UTC).
- name: sort
in: query
required: false
schema:
$ref: '#/components/schemas/PaginationSortMethod'
description: Sort the results (asc/desc)
default: desc
description: Sort the results (asc/desc)
- name: page_size
in: query
required: false
schema:
type: integer
description: Page size. Default is 10. Must be greater than 0 and less than 5000.
default: 10
title: Page Size
description: Page size. Default is 10. Must be greater than 0 and less than 5000.
- name: page
in: query
required: false
schema:
type: integer
description: Page number
default: 0
title: Page
description: Page number
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TraceUserListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/traces/users/{user_id}:
get:
tags:
- Users
summary: Get User Details
description: Get detailed information for a single user including session and trace metadata.
operationId: get_user_details_api_v1_traces_users__user_id__get
security:
- API Key: []
parameters:
- name: user_id
in: path
required: true
schema:
type: string
title: User Id
- name: task_ids
in: query
required: true
schema:
type: array
items:
type: string
minItems: 1
description: Task IDs to filter on. At least one is required.
title: Task Ids
description: Task IDs to filter on. At least one is required.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TraceUserMetadataResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
TraceUserMetadataResponse:
properties:
prompt_token_count:
anyOf:
- type: integer
- type: 'null'
title: Prompt Token Count
description: Number of prompt tokens
completion_token_count:
anyOf:
- type: integer
- type: 'null'
title: Completion Token Count
description: Number of completion tokens
total_token_count:
anyOf:
- type: integer
- type: 'null'
title: Total Token Count
description: Total number of tokens
prompt_token_cost:
anyOf:
- type: number
- type: 'null'
title: Prompt Token Cost
description: Cost of prompt tokens in USD
completion_token_cost:
anyOf:
- type: number
- type: 'null'
title: Completion Token Cost
description: Cost of completion tokens in USD
total_token_cost:
anyOf:
- type: number
- type: 'null'
title: Total Token Cost
description: Total cost in USD
user_id:
type: string
title: User Id
description: User identifier
task_id:
type: string
title: Task Id
description: Task ID this user belongs to
session_ids:
items:
type: string
type: array
title: Session Ids
description: List of session IDs for this user
session_count:
type: integer
title: Session Count
description: Number of sessions for this user
trace_ids:
items:
type: string
type: array
title: Trace Ids
description: List of trace IDs for this user
trace_count:
type: integer
title: Trace Count
description: Number of traces for this user
span_count:
type: integer
title: Span Count
description: Total number of spans for this user
earliest_start_time:
type: string
format: date-time
title: Earliest Start Time
description: Start time of earliest trace
latest_end_time:
type: string
format: date-time
title: Latest End Time
description: End time of latest trace
type: object
required:
- user_id
- task_id
- session_ids
- session_count
- trace_ids
- trace_count
- span_count
- earliest_start_time
- latest_end_time
title: TraceUserMetadataResponse
description: User summary metadata in trace context
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
TraceUserListResponse:
properties:
count:
type: integer
title: Count
description: Total number of users matching filters
display_currency:
anyOf:
- type: string
- type: 'null'
title: Display Currency
description: Currency code for cost fields
users:
items:
$ref: '#/components/schemas/TraceUserMetadataResponse'
type: array
title: Users
description: List of user metadata
type: object
required:
- count
- users
title: TraceUserListResponse
description: Response for trace user list endpoint
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
PaginationSortMethod:
type: string
enum:
- asc
- desc
title: PaginationSortMethod
securitySchemes:
API Key:
type: http
description: Bearer token authentication with an API key
scheme: bearer