/agents/{agent_ id}/sessions/{session_ id}/chat
"/agents/{agent_id}/sessions/{session_id}/chat" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { agent_id : string ; session_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : | { attachUserId ?: boolean ; contexts ?: ( | { otelSpanId ?: ...; projectNodeId ?: ...; spanNodeId ?: ...; type : ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | { projectNodeId : ...; rootSpansOnly ?: ...; spanFilter ?: ...; type : ...; } | { otelTraceId : ...; projectNodeId : ...; type : ... } | { projectNodeId : ...; sessionNodeId : ...; type : ... } | { promptNodeId : ...; type : ... } | { promptNodeId : ...; promptVersionNodeId : ...; type : ... } | { evaluators ?: ...; instances ?: ...; nextExperimentScaffold ?: ...; recordExperiments ?: ...; repetitions ?: ...; type : ...; } | { evaluatorNodeId ?: ...; type : ... } | { evaluatorNodeId ?: ...; type : ... } | { datasetNodeId : ...; datasetVersionNodeId ?: ...; type : ... } | { mutationsEnabled : ...; type : ... } | { enabled : ...; type : ... } | { enabled : ...; type : ... } )[] ; editPermission ?: "manual" | "bypass" ; exportRemoteTraces ?: boolean ; id : string ; ingestTraces ?: boolean ; messageId ?: string | null ; messages : { id : string ; metadata ?: | { sessionId : ...; trace ?: ...; turnTraceContext ?: ...; type : ...; usage ?: ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | null ; parts : ( | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) )[] ; role : "assistant" | "system" | "user" ; } [] ; model : | { modelName : string ; openaiApiType ?: "chat_completions" | "responses" ; provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; providerType : "builtin" ; } | { modelName : string ; providerId : string ; providerType : "custom" } ; requestedSkills ?: string [] ; trigger : "regenerate-message" ; turnTraceContext ?: | { rootSpanId : string ; startedAt : string ; traceId : string } | null ; } & { [ key : string ]: unknown } | { attachUserId ?: boolean ; contexts ?: ( | { otelSpanId ?: ...; projectNodeId ?: ...; spanNodeId ?: ...; type : ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | { projectNodeId : ...; rootSpansOnly ?: ...; spanFilter ?: ...; type : ...; } | { otelTraceId : ...; projectNodeId : ...; type : ... } | { projectNodeId : ...; sessionNodeId : ...; type : ... } | { promptNodeId : ...; type : ... } | { promptNodeId : ...; promptVersionNodeId : ...; type : ... } | { evaluators ?: ...; instances ?: ...; nextExperimentScaffold ?: ...; recordExperiments ?: ...; repetitions ?: ...; type : ...; } | { evaluatorNodeId ?: ...; type : ... } | { evaluatorNodeId ?: ...; type : ... } | { datasetNodeId : ...; datasetVersionNodeId ?: ...; type : ... } | { mutationsEnabled : ...; type : ... } | { enabled : ...; type : ... } | { enabled : ...; type : ... } )[] ; editPermission ?: "manual" | "bypass" ; exportRemoteTraces ?: boolean ; id : string ; ingestTraces ?: boolean ; messages : { id : string ; metadata ?: | { sessionId : ...; trace ?: ...; turnTraceContext ?: ...; type : ...; usage ?: ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | null ; parts : ( | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) )[] ; role : "assistant" | "system" | "user" ; } [] ; model : | { modelName : string ; openaiApiType ?: "chat_completions" | "responses" ; provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; providerType : "builtin" ; } | { modelName : string ; providerId : string ; providerType : "custom" } ; requestedSkills ?: string [] ; trigger : "submit-message" ; turnTraceContext ?: | { rootSpanId : string ; startedAt : string ; traceId : string } | null ; } & { [ key : string ]: unknown } ; } ; } ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { agent_id : string ; session_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : | { attachUserId ?: boolean ; contexts ?: ( | { otelSpanId ?: ...; projectNodeId ?: ...; spanNodeId ?: ...; type : ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | { projectNodeId : ...; rootSpansOnly ?: ...; spanFilter ?: ...; type : ...; } | { otelTraceId : ...; projectNodeId : ...; type : ... } | { projectNodeId : ...; sessionNodeId : ...; type : ... } | { promptNodeId : ...; type : ... } | { promptNodeId : ...; promptVersionNodeId : ...; type : ... } | { evaluators ?: ...; instances ?: ...; nextExperimentScaffold ?: ...; recordExperiments ?: ...; repetitions ?: ...; type : ...; } | { evaluatorNodeId ?: ...; type : ... } | { evaluatorNodeId ?: ...; type : ... } | { datasetNodeId : ...; datasetVersionNodeId ?: ...; type : ... } | { mutationsEnabled : ...; type : ... } | { enabled : ...; type : ... } | { enabled : ...; type : ... } )[] ; editPermission ?: "manual" | "bypass" ; exportRemoteTraces ?: boolean ; id : string ; ingestTraces ?: boolean ; messageId ?: string | null ; messages : { id : string ; metadata ?: | { sessionId : ...; trace ?: ...; turnTraceContext ?: ...; type : ...; usage ?: ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | null ; parts : ( | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) )[] ; role : "assistant" | "system" | "user" ; } [] ; model : | { modelName : string ; openaiApiType ?: "chat_completions" | "responses" ; provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; providerType : "builtin" ; } | { modelName : string ; providerId : string ; providerType : "custom" } ; requestedSkills ?: string [] ; trigger : "regenerate-message" ; turnTraceContext ?: | { rootSpanId : string ; startedAt : string ; traceId : string } | null ; } & { [ key : string ]: unknown } | { attachUserId ?: boolean ; contexts ?: ( | { otelSpanId ?: ...; projectNodeId ?: ...; spanNodeId ?: ...; type : ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | { projectNodeId : ...; rootSpansOnly ?: ...; spanFilter ?: ...; type : ...; } | { otelTraceId : ...; projectNodeId : ...; type : ... } | { projectNodeId : ...; sessionNodeId : ...; type : ... } | { promptNodeId : ...; type : ... } | { promptNodeId : ...; promptVersionNodeId : ...; type : ... } | { evaluators ?: ...; instances ?: ...; nextExperimentScaffold ?: ...; recordExperiments ?: ...; repetitions ?: ...; type : ...; } | { evaluatorNodeId ?: ...; type : ... } | { evaluatorNodeId ?: ...; type : ... } | { datasetNodeId : ...; datasetVersionNodeId ?: ...; type : ... } | { mutationsEnabled : ...; type : ... } | { enabled : ...; type : ... } | { enabled : ...; type : ... } )[] ; editPermission ?: "manual" | "bypass" ; exportRemoteTraces ?: boolean ; id : string ; ingestTraces ?: boolean ; messages : { id : string ; metadata ?: | { sessionId : ...; trace ?: ...; turnTraceContext ?: ...; type : ...; usage ?: ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | null ; parts : ( | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) )[] ; role : "assistant" | "system" | "user" ; } [] ; model : | { modelName : string ; openaiApiType ?: "chat_completions" | "responses" ; provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; providerType : "builtin" ; } | { modelName : string ; providerId : string ; providerType : "custom" } ; requestedSkills ?: string [] ; trigger : "submit-message" ; turnTraceContext ?: | { rootSpanId : string ; startedAt : string ; traceId : string } | null ; } & { [ key : string ]: unknown } ; } ; } ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { agent_id : string ; session_id : string } ; query ?: undefined ; }
requestBody : { content : { "application/json" : | { attachUserId ?: boolean ; contexts ?: ( | { otelSpanId ?: ...; projectNodeId ?: ...; spanNodeId ?: ...; type : ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | { projectNodeId : ...; rootSpansOnly ?: ...; spanFilter ?: ...; type : ...; } | { otelTraceId : ...; projectNodeId : ...; type : ... } | { projectNodeId : ...; sessionNodeId : ...; type : ... } | { promptNodeId : ...; type : ... } | { promptNodeId : ...; promptVersionNodeId : ...; type : ... } | { evaluators ?: ...; instances ?: ...; nextExperimentScaffold ?: ...; recordExperiments ?: ...; repetitions ?: ...; type : ...; } | { evaluatorNodeId ?: ...; type : ... } | { evaluatorNodeId ?: ...; type : ... } | { datasetNodeId : ...; datasetVersionNodeId ?: ...; type : ... } | { mutationsEnabled : ...; type : ... } | { enabled : ...; type : ... } | { enabled : ...; type : ... } )[] ; editPermission ?: "manual" | "bypass" ; exportRemoteTraces ?: boolean ; id : string ; ingestTraces ?: boolean ; messageId ?: string | null ; messages : { id : string ; metadata ?: | { sessionId : ...; trace ?: ...; turnTraceContext ?: ...; type : ...; usage ?: ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | null ; parts : ( | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) )[] ; role : "assistant" | "system" | "user" ; } [] ; model : | { modelName : string ; openaiApiType ?: "chat_completions" | "responses" ; provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; providerType : "builtin" ; } | { modelName : string ; providerId : string ; providerType : "custom" } ; requestedSkills ?: string [] ; trigger : "regenerate-message" ; turnTraceContext ?: | { rootSpanId : string ; startedAt : string ; traceId : string } | null ; } & { [ key : string ]: unknown } | { attachUserId ?: boolean ; contexts ?: ( | { otelSpanId ?: ...; projectNodeId ?: ...; spanNodeId ?: ...; type : ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | { projectNodeId : ...; rootSpansOnly ?: ...; spanFilter ?: ...; type : ...; } | { otelTraceId : ...; projectNodeId : ...; type : ... } | { projectNodeId : ...; sessionNodeId : ...; type : ... } | { promptNodeId : ...; type : ... } | { promptNodeId : ...; promptVersionNodeId : ...; type : ... } | { evaluators ?: ...; instances ?: ...; nextExperimentScaffold ?: ...; recordExperiments ?: ...; repetitions ?: ...; type : ...; } | { evaluatorNodeId ?: ...; type : ... } | { evaluatorNodeId ?: ...; type : ... } | { datasetNodeId : ...; datasetVersionNodeId ?: ...; type : ... } | { mutationsEnabled : ...; type : ... } | { enabled : ...; type : ... } | { enabled : ...; type : ... } )[] ; editPermission ?: "manual" | "bypass" ; exportRemoteTraces ?: boolean ; id : string ; ingestTraces ?: boolean ; messages : { id : string ; metadata ?: | { sessionId : ...; trace ?: ...; turnTraceContext ?: ...; type : ...; usage ?: ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | null ; parts : ( | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) )[] ; role : "assistant" | "system" | "user" ; } [] ; model : | { modelName : string ; openaiApiType ?: "chat_completions" | "responses" ; provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; providerType : "builtin" ; } | { modelName : string ; providerId : string ; providerType : "custom" } ; requestedSkills ?: string [] ; trigger : "submit-message" ; turnTraceContext ?: | { rootSpanId : string ; startedAt : string ; traceId : string } | null ; } & { [ key : string ]: unknown } ; } ; }
responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/agents/{agent_ id}/sessions/{session_ id}/summary
"/agents/{agent_id}/sessions/{session_id}/summary" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { agent_id : string ; session_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { attachUserId ?: boolean ; exportRemoteTraces ?: boolean ; ingestTraces ?: boolean ; messages : { id : string ; metadata ?: unknown ; parts : ( | { data : unknown ; id ?: (...) | (...) | (...); type : string } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input : unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input : unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input : unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input : unknown ; output : unknown ; preliminary ?: (...) | (...) | (...) | (...); providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input : unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); errorText : string ; input : unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { filename ?: (...) | (...) | (...); mediaType : string ; providerMetadata ?: (...) | (...) | (...); type ?: (...) | (...); url : string ; } | { providerMetadata ?: (...) | (...) | (...); state ?: (...) | (...) | (...) | (...); text : string ; type ?: (...) | (...); } | { providerMetadata ?: (...) | (...) | (...); state ?: (...) | (...) | (...) | (...); text : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; output ?: unknown ; preliminary ?: (...) | (...) | (...) | (...); providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); errorText : string ; input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); rawInput ?: unknown ; state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { providerMetadata ?: (...) | (...) | (...); sourceId : string ; title ?: (...) | (...) | (...); type ?: (...) | (...); url : string ; } | { filename ?: (...) | (...) | (...); mediaType : string ; providerMetadata ?: (...) | (...) | (...); sourceId : string ; title : string ; type ?: (...) | (...); } | { type ?: (...) | (...) } )[] ; role : "assistant" | "system" | "user" ; } [] ; model : | { modelName : string ; openaiApiType ?: "chat_completions" | "responses" ; provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; providerType : "builtin" ; } | { modelName : string ; providerId : string ; providerType : "custom" } ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { summary : string } } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { agent_id : string ; session_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { attachUserId ?: boolean ; exportRemoteTraces ?: boolean ; ingestTraces ?: boolean ; messages : { id : string ; metadata ?: unknown ; parts : ( | { data : unknown ; id ?: (...) | (...) | (...); type : string } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input : unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input : unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input : unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input : unknown ; output : unknown ; preliminary ?: (...) | (...) | (...) | (...); providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input : unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); errorText : string ; input : unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { filename ?: (...) | (...) | (...); mediaType : string ; providerMetadata ?: (...) | (...) | (...); type ?: (...) | (...); url : string ; } | { providerMetadata ?: (...) | (...) | (...); state ?: (...) | (...) | (...) | (...); text : string ; type ?: (...) | (...); } | { providerMetadata ?: (...) | (...) | (...); state ?: (...) | (...) | (...) | (...); text : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; output ?: unknown ; preliminary ?: (...) | (...) | (...) | (...); providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); errorText : string ; input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); rawInput ?: unknown ; state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { providerMetadata ?: (...) | (...) | (...); sourceId : string ; title ?: (...) | (...) | (...); type ?: (...) | (...); url : string ; } | { filename ?: (...) | (...) | (...); mediaType : string ; providerMetadata ?: (...) | (...) | (...); sourceId : string ; title : string ; type ?: (...) | (...); } | { type ?: (...) | (...) } )[] ; role : "assistant" | "system" | "user" ; } [] ; model : | { modelName : string ; openaiApiType ?: "chat_completions" | "responses" ; provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; providerType : "builtin" ; } | { modelName : string ; providerId : string ; providerType : "custom" } ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { summary : string } } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { agent_id : string ; session_id : string } ; query ?: undefined ; }
requestBody : { content : { "application/json" : { attachUserId ?: boolean ; exportRemoteTraces ?: boolean ; ingestTraces ?: boolean ; messages : { id : string ; metadata ?: unknown ; parts : ( | { data : unknown ; id ?: (...) | (...) | (...); type : string } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input : unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input : unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input : unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input : unknown ; output : unknown ; preliminary ?: (...) | (...) | (...) | (...); providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input : unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); errorText : string ; input : unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; toolName : string ; type ?: (...) | (...); } | { filename ?: (...) | (...) | (...); mediaType : string ; providerMetadata ?: (...) | (...) | (...); type ?: (...) | (...); url : string ; } | { providerMetadata ?: (...) | (...) | (...); state ?: (...) | (...) | (...) | (...); text : string ; type ?: (...) | (...); } | { providerMetadata ?: (...) | (...) | (...); state ?: (...) | (...) | (...) | (...); text : string ; type ?: (...) | (...); } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; output ?: unknown ; preliminary ?: (...) | (...) | (...) | (...); providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); errorText : string ; input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); rawInput ?: unknown ; state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { approval ?: (...) | (...) | (...) | (...); callProviderMetadata ?: (...) | (...) | (...); input ?: unknown ; providerExecuted ?: (...) | (...) | (...) | (...); state ?: (...) | (...); title ?: (...) | (...) | (...); toolCallId : string ; type : string ; } | { providerMetadata ?: (...) | (...) | (...); sourceId : string ; title ?: (...) | (...) | (...); type ?: (...) | (...); url : string ; } | { filename ?: (...) | (...) | (...); mediaType : string ; providerMetadata ?: (...) | (...) | (...); sourceId : string ; title : string ; type ?: (...) | (...); } | { type ?: (...) | (...) } )[] ; role : "assistant" | "system" | "user" ; } [] ; model : | { modelName : string ; openaiApiType ?: "chat_completions" | "responses" ; provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; providerType : "builtin" ; } | { modelName : string ; providerId : string ; providerType : "custom" } ; } ; } ; }
responses : { "200" : { content : { "application/json" : { summary : string } } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { summary : string } } ; headers : { [ name : string ]: unknown } ; }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/agents/server/sessions/{session_ id}/chat
"/agents/server/sessions/{session_id}/chat" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { session_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : | { attachUserId ?: boolean ; contexts ?: ( | { otelSpanId ?: ...; projectNodeId ?: ...; spanNodeId ?: ...; type : ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | { projectNodeId : ...; rootSpansOnly ?: ...; spanFilter ?: ...; type : ...; } | { otelTraceId : ...; projectNodeId : ...; type : ... } | { projectNodeId : ...; sessionNodeId : ...; type : ... } | { promptNodeId : ...; type : ... } | { promptNodeId : ...; promptVersionNodeId : ...; type : ... } | { evaluators ?: ...; instances ?: ...; nextExperimentScaffold ?: ...; recordExperiments ?: ...; repetitions ?: ...; type : ...; } | { evaluatorNodeId ?: ...; type : ... } | { evaluatorNodeId ?: ...; type : ... } | { datasetNodeId : ...; datasetVersionNodeId ?: ...; type : ... } | { mutationsEnabled : ...; type : ... } | { enabled : ...; type : ... } | { enabled : ...; type : ... } )[] ; editPermission ?: "manual" | "bypass" ; exportRemoteTraces ?: boolean ; id : string ; ingestTraces ?: boolean ; messageId ?: string | null ; messages : { id : string ; metadata ?: | { sessionId : ...; trace ?: ...; turnTraceContext ?: ...; type : ...; usage ?: ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | null ; parts : ( | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) )[] ; role : "assistant" | "system" | "user" ; } [] ; model : | { modelName : string ; openaiApiType ?: "chat_completions" | "responses" ; provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; providerType : "builtin" ; } | { modelName : string ; providerId : string ; providerType : "custom" } ; requestedSkills ?: string [] ; trigger : "regenerate-message" ; turnTraceContext ?: | { rootSpanId : string ; startedAt : string ; traceId : string } | null ; } & { [ key : string ]: unknown } | { attachUserId ?: boolean ; contexts ?: ( | { otelSpanId ?: ...; projectNodeId ?: ...; spanNodeId ?: ...; type : ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | { projectNodeId : ...; rootSpansOnly ?: ...; spanFilter ?: ...; type : ...; } | { otelTraceId : ...; projectNodeId : ...; type : ... } | { projectNodeId : ...; sessionNodeId : ...; type : ... } | { promptNodeId : ...; type : ... } | { promptNodeId : ...; promptVersionNodeId : ...; type : ... } | { evaluators ?: ...; instances ?: ...; nextExperimentScaffold ?: ...; recordExperiments ?: ...; repetitions ?: ...; type : ...; } | { evaluatorNodeId ?: ...; type : ... } | { evaluatorNodeId ?: ...; type : ... } | { datasetNodeId : ...; datasetVersionNodeId ?: ...; type : ... } | { mutationsEnabled : ...; type : ... } | { enabled : ...; type : ... } | { enabled : ...; type : ... } )[] ; editPermission ?: "manual" | "bypass" ; exportRemoteTraces ?: boolean ; id : string ; ingestTraces ?: boolean ; messages : { id : string ; metadata ?: | { sessionId : ...; trace ?: ...; turnTraceContext ?: ...; type : ...; usage ?: ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | null ; parts : ( | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) )[] ; role : "assistant" | "system" | "user" ; } [] ; model : | { modelName : string ; openaiApiType ?: "chat_completions" | "responses" ; provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; providerType : "builtin" ; } | { modelName : string ; providerId : string ; providerType : "custom" } ; requestedSkills ?: string [] ; trigger : "submit-message" ; turnTraceContext ?: | { rootSpanId : string ; startedAt : string ; traceId : string } | null ; } & { [ key : string ]: unknown } ; } ; } ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { session_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : | { attachUserId ?: boolean ; contexts ?: ( | { otelSpanId ?: ...; projectNodeId ?: ...; spanNodeId ?: ...; type : ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | { projectNodeId : ...; rootSpansOnly ?: ...; spanFilter ?: ...; type : ...; } | { otelTraceId : ...; projectNodeId : ...; type : ... } | { projectNodeId : ...; sessionNodeId : ...; type : ... } | { promptNodeId : ...; type : ... } | { promptNodeId : ...; promptVersionNodeId : ...; type : ... } | { evaluators ?: ...; instances ?: ...; nextExperimentScaffold ?: ...; recordExperiments ?: ...; repetitions ?: ...; type : ...; } | { evaluatorNodeId ?: ...; type : ... } | { evaluatorNodeId ?: ...; type : ... } | { datasetNodeId : ...; datasetVersionNodeId ?: ...; type : ... } | { mutationsEnabled : ...; type : ... } | { enabled : ...; type : ... } | { enabled : ...; type : ... } )[] ; editPermission ?: "manual" | "bypass" ; exportRemoteTraces ?: boolean ; id : string ; ingestTraces ?: boolean ; messageId ?: string | null ; messages : { id : string ; metadata ?: | { sessionId : ...; trace ?: ...; turnTraceContext ?: ...; type : ...; usage ?: ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | null ; parts : ( | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) )[] ; role : "assistant" | "system" | "user" ; } [] ; model : | { modelName : string ; openaiApiType ?: "chat_completions" | "responses" ; provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; providerType : "builtin" ; } | { modelName : string ; providerId : string ; providerType : "custom" } ; requestedSkills ?: string [] ; trigger : "regenerate-message" ; turnTraceContext ?: | { rootSpanId : string ; startedAt : string ; traceId : string } | null ; } & { [ key : string ]: unknown } | { attachUserId ?: boolean ; contexts ?: ( | { otelSpanId ?: ...; projectNodeId ?: ...; spanNodeId ?: ...; type : ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | { projectNodeId : ...; rootSpansOnly ?: ...; spanFilter ?: ...; type : ...; } | { otelTraceId : ...; projectNodeId : ...; type : ... } | { projectNodeId : ...; sessionNodeId : ...; type : ... } | { promptNodeId : ...; type : ... } | { promptNodeId : ...; promptVersionNodeId : ...; type : ... } | { evaluators ?: ...; instances ?: ...; nextExperimentScaffold ?: ...; recordExperiments ?: ...; repetitions ?: ...; type : ...; } | { evaluatorNodeId ?: ...; type : ... } | { evaluatorNodeId ?: ...; type : ... } | { datasetNodeId : ...; datasetVersionNodeId ?: ...; type : ... } | { mutationsEnabled : ...; type : ... } | { enabled : ...; type : ... } | { enabled : ...; type : ... } )[] ; editPermission ?: "manual" | "bypass" ; exportRemoteTraces ?: boolean ; id : string ; ingestTraces ?: boolean ; messages : { id : string ; metadata ?: | { sessionId : ...; trace ?: ...; turnTraceContext ?: ...; type : ...; usage ?: ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | null ; parts : ( | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) )[] ; role : "assistant" | "system" | "user" ; } [] ; model : | { modelName : string ; openaiApiType ?: "chat_completions" | "responses" ; provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; providerType : "builtin" ; } | { modelName : string ; providerId : string ; providerType : "custom" } ; requestedSkills ?: string [] ; trigger : "submit-message" ; turnTraceContext ?: | { rootSpanId : string ; startedAt : string ; traceId : string } | null ; } & { [ key : string ]: unknown } ; } ; } ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { session_id : string } ; query ?: undefined ; }
requestBody : { content : { "application/json" : | { attachUserId ?: boolean ; contexts ?: ( | { otelSpanId ?: ...; projectNodeId ?: ...; spanNodeId ?: ...; type : ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | { projectNodeId : ...; rootSpansOnly ?: ...; spanFilter ?: ...; type : ...; } | { otelTraceId : ...; projectNodeId : ...; type : ... } | { projectNodeId : ...; sessionNodeId : ...; type : ... } | { promptNodeId : ...; type : ... } | { promptNodeId : ...; promptVersionNodeId : ...; type : ... } | { evaluators ?: ...; instances ?: ...; nextExperimentScaffold ?: ...; recordExperiments ?: ...; repetitions ?: ...; type : ...; } | { evaluatorNodeId ?: ...; type : ... } | { evaluatorNodeId ?: ...; type : ... } | { datasetNodeId : ...; datasetVersionNodeId ?: ...; type : ... } | { mutationsEnabled : ...; type : ... } | { enabled : ...; type : ... } | { enabled : ...; type : ... } )[] ; editPermission ?: "manual" | "bypass" ; exportRemoteTraces ?: boolean ; id : string ; ingestTraces ?: boolean ; messageId ?: string | null ; messages : { id : string ; metadata ?: | { sessionId : ...; trace ?: ...; turnTraceContext ?: ...; type : ...; usage ?: ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | null ; parts : ( | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) )[] ; role : "assistant" | "system" | "user" ; } [] ; model : | { modelName : string ; openaiApiType ?: "chat_completions" | "responses" ; provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; providerType : "builtin" ; } | { modelName : string ; providerId : string ; providerType : "custom" } ; requestedSkills ?: string [] ; trigger : "regenerate-message" ; turnTraceContext ?: | { rootSpanId : string ; startedAt : string ; traceId : string } | null ; } & { [ key : string ]: unknown } | { attachUserId ?: boolean ; contexts ?: ( | { otelSpanId ?: ...; projectNodeId ?: ...; spanNodeId ?: ...; type : ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | { projectNodeId : ...; rootSpansOnly ?: ...; spanFilter ?: ...; type : ...; } | { otelTraceId : ...; projectNodeId : ...; type : ... } | { projectNodeId : ...; sessionNodeId : ...; type : ... } | { promptNodeId : ...; type : ... } | { promptNodeId : ...; promptVersionNodeId : ...; type : ... } | { evaluators ?: ...; instances ?: ...; nextExperimentScaffold ?: ...; recordExperiments ?: ...; repetitions ?: ...; type : ...; } | { evaluatorNodeId ?: ...; type : ... } | { evaluatorNodeId ?: ...; type : ... } | { datasetNodeId : ...; datasetVersionNodeId ?: ...; type : ... } | { mutationsEnabled : ...; type : ... } | { enabled : ...; type : ... } | { enabled : ...; type : ... } )[] ; editPermission ?: "manual" | "bypass" ; exportRemoteTraces ?: boolean ; id : string ; ingestTraces ?: boolean ; messages : { id : string ; metadata ?: | { sessionId : ...; trace ?: ...; turnTraceContext ?: ...; type : ...; usage ?: ...; } | { currentDateTime : ...; timeZone : ...; type : ... } | null ; parts : ( | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) | (...) )[] ; role : "assistant" | "system" | "user" ; } [] ; model : | { modelName : string ; openaiApiType ?: "chat_completions" | "responses" ; provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; providerType : "builtin" ; } | { modelName : string ; providerId : string ; providerType : "custom" } ; requestedSkills ?: string [] ; trigger : "submit-message" ; turnTraceContext ?: | { rootSpanId : string ; startedAt : string ; traceId : string } | null ; } & { [ key : string ]: unknown } ; } ; }
responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/arize_ phoenix_ version
"/arize_phoenix_version" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/auth/ldap/login
"/auth/ldap/login" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/auth/login
"/auth/login" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/auth/logout
"/auth/logout" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/auth/password- reset
"/auth/password-reset" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/auth/password- reset- email
"/auth/password-reset-email" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/auth/refresh
"/auth/refresh" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/healthz
"/healthz" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/oauth2/{idp_ name}/login
"/oauth2/{idp_name}/login" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { idp_name : string } ; query ?: { returnUrl ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { idp_name : string } ; query ?: { returnUrl ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { idp_name : string } ; query ?: { returnUrl ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { idp_name : string } ; query ?: { returnUrl ?: string | null } ; }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { idp_name : string } ; query ?: { returnUrl ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { idp_name : string } ; query ?: { returnUrl ?: string | null } ; }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/oauth2/{idp_ name}/tokens
"/oauth2/{idp_name}/tokens" : { delete ?: undefined ; get : { parameters : { cookie : { "phoenix-oauth2-code-verifier" ?: string | null ; "phoenix-oauth2-nonce" : string ; "phoenix-oauth2-state" : string ; } ; header ?: undefined ; path : { idp_name : string } ; query : { code ?: string | null ; error ?: string | null ; error_description ?: string | null ; state : string ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie : { "phoenix-oauth2-code-verifier" ?: string | null ; "phoenix-oauth2-nonce" : string ; "phoenix-oauth2-state" : string ; } ; header ?: undefined ; path : { idp_name : string } ; query : { code ?: string | null ; error ?: string | null ; error_description ?: string | null ; state : string ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie : { "phoenix-oauth2-code-verifier" ?: string | null ; "phoenix-oauth2-nonce" : string ; "phoenix-oauth2-state" : string ; } ; header ?: undefined ; path : { idp_name : string } ; query : { code ?: string | null ; error ?: string | null ; error_description ?: string | null ; state : string ; } ; }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/readyz
"/readyz" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : unknown } ; headers : { [ name : string ]: unknown } ; }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/annotation_ configs
"/v1/annotation_configs" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : ( | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : ...; score ?: ... } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : | { description ?: string | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: number | null } [] ; } | { description ?: string | null ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : ( | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : ...; score ?: ... } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; limit ?: number } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { cursor ?: string | null ; limit ?: number }
Optionalcursor ?: string | null
Optionallimit ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : ( | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : ...; score ?: ... } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : ( | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : ...; score ?: ... } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : | { description ?: string | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: number | null } [] ; } | { description ?: string | null ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : | { description ?: string | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: number | null } [] ; } | { description ?: string | null ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/annotation_ configs/{config_ id}
"/v1/annotation_configs/{config_id}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { config_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { config_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : | { description ?: string | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: number | null } [] ; } | { description ?: string | null ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { config_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { config_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { config_id : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { config_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : | { description ?: string | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: number | null } [] ; } | { description ?: string | null ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { config_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { config_id : string }
Optionalquery ?: undefined
requestBody : { content : { "application/json" : | { description ?: string | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: number | null } [] ; } | { description ?: string | null ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionaltrace ?: undefined
/v1/annotation_ configs/{config_ identifier}
"/v1/annotation_configs/{config_identifier}" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { config_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { config_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { config_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { config_identifier : string }
config_identifier : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/dataset_ labels
"/v1/dataset_labels" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { color : string ; description ?: string | null ; name : string ; } ; } ; } ; responses : { "201" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "409" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; limit ?: number } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { cursor ?: string | null ; limit ?: number }
Optionalcursor ?: string | null
Optionallimit ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { color : string ; description ?: string | null ; name : string ; } ; } ; } ; responses : { "201" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "409" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : { color : string ; description ?: string | null ; name : string ; } ; } ; }
responses : { "201" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "409" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
201 : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
409 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/dataset_ labels/{label_ id}
"/v1/dataset_labels/{label_id}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { label_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { label_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { label_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { color ?: string | null ; description ?: string | null ; name ?: string | null ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "409" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { label_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { label_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { label_id : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { label_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { label_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { label_id : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
patch : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { label_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { color ?: string | null ; description ?: string | null ; name ?: string | null ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "409" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { label_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { label_id : string }
Optionalquery ?: undefined
requestBody : { content : { "application/json" : { color ?: string | null ; description ?: string | null ; name ?: string | null ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "409" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
409 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/datasets
"/v1/datasets" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; limit ?: number ; name ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description : string | null ; example_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; name : string ; updated_at : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; limit ?: number ; name ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description : string | null ; example_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; name : string ; updated_at : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; limit ?: number ; name ?: string | null } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { cursor ?: string | null ; limit ?: number ; name ?: string | null }
Optionalcursor ?: string | null
Optionallimit ?: number
Optionalname ?: string | null
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description : string | null ; example_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; name : string ; updated_at : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { created_at : string ; description : string | null ; example_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; name : string ; updated_at : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/datasets/{dataset_ id}/experiments
"/v1/datasets/{dataset_id}/experiments" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_id : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { description ?: string | null ; metadata ?: { [ key : string ]: unknown } | null ; name ?: string | null ; repetitions ?: number ; splits ?: string [] | null ; version_id ?: string | null ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_id : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_id : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { dataset_id : string }
Optionalquery ?: { cursor ?: string | null ; limit ?: number }
Optionalcursor ?: string | null
Optionallimit ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { description ?: string | null ; metadata ?: { [ key : string ]: unknown } | null ; name ?: string | null ; repetitions ?: number ; splits ?: string [] | null ; version_id ?: string | null ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_id : string } ; query ?: undefined ; }
requestBody : { content : { "application/json" : { description ?: string | null ; metadata ?: { [ key : string ]: unknown } | null ; name ?: string | null ; repetitions ?: number ; splits ?: string [] | null ; version_id ?: string | null ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/datasets/{dataset_ identifier}/labels
"/v1/datasets/{dataset_identifier}/labels" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_identifier : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { dataset_label_ids ?: string [] } } ; } ; responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { dataset_identifier : string }
dataset_identifier : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_identifier : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { dataset_label_ids ?: string [] } } ; } ; responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { dataset_identifier : string }
dataset_identifier : string
Optionalquery ?: undefined
requestBody : { content : { "application/json" : { dataset_label_ids ?: string [] } } }
responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionaltrace ?: undefined
/v1/datasets/{dataset_ identifier}/labels/{label_ id}
"/v1/datasets/{dataset_identifier}/labels/{label_id}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_identifier : string ; label_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_identifier : string ; label_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_identifier : string ; label_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_identifier : string ; label_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { dataset_identifier : string ; label_id : string }
dataset_identifier : string
label_id : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_identifier : string ; label_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { dataset_identifier : string ; label_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { dataset_identifier : string ; label_id : string }
dataset_identifier : string
label_id : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { color : string ; description : string | null ; id : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionaltrace ?: undefined
/v1/datasets/{id}
"/v1/datasets/{id}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description : string | null ; example_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; name : string ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { id : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description : string | null ; example_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; name : string ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { id : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description : string | null ; example_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; name : string ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { created_at : string ; description : string | null ; example_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; name : string ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/datasets/{id}/csv
"/v1/datasets/{id}/csv" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { version_id ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "text/csv" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { version_id ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "text/csv" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { version_id ?: string | null } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { id : string }
Optionalquery ?: { version_id ?: string | null }
Optionalversion_id ?: string | null
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "text/csv" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "text/csv" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/datasets/{id}/examples
"/v1/datasets/{id}/examples" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { split ?: string [] | null ; version_id ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { dataset_id : string ; examples : { id : string ; input : { [ key : string ]: unknown } ; metadata : { [ key : string ]: unknown } ; node_id : string ; output : { [ key : string ]: unknown } ; source ?: { span_id : ...; span_node_id : ... } | null ; updated_at : string ; } [] ; filtered_splits ?: string [] ; version_id : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { split ?: string [] | null ; version_id ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { dataset_id : string ; examples : { id : string ; input : { [ key : string ]: unknown } ; metadata : { [ key : string ]: unknown } ; node_id : string ; output : { [ key : string ]: unknown } ; source ?: { span_id : ...; span_node_id : ... } | null ; updated_at : string ; } [] ; filtered_splits ?: string [] ; version_id : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { split ?: string [] | null ; version_id ?: string | null } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { id : string }
Optionalquery ?: { split ?: string [] | null ; version_id ?: string | null }
Optionalsplit ?: string [] | null
Optionalversion_id ?: string | null
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { dataset_id : string ; examples : { id : string ; input : { [ key : string ]: unknown } ; metadata : { [ key : string ]: unknown } ; node_id : string ; output : { [ key : string ]: unknown } ; source ?: { span_id : ...; span_node_id : ... } | null ; updated_at : string ; } [] ; filtered_splits ?: string [] ; version_id : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { dataset_id : string ; examples : { id : string ; input : { [ key : string ]: unknown } ; metadata : { [ key : string ]: unknown } ; node_id : string ; output : { [ key : string ]: unknown } ; source ?: { span_id : ...; span_node_id : ... } | null ; updated_at : string ; } [] ; filtered_splits ?: string [] ; version_id : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/datasets/{id}/jsonl
"/v1/datasets/{id}/jsonl" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { version_id ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { version_id ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { version_id ?: string | null } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { id : string }
Optionalquery ?: { version_id ?: string | null }
Optionalversion_id ?: string | null
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/datasets/{id}/jsonl/openai_ evals
"/v1/datasets/{id}/jsonl/openai_evals" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { version_id ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { version_id ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { version_id ?: string | null } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { id : string }
Optionalquery ?: { version_id ?: string | null }
Optionalversion_id ?: string | null
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/datasets/{id}/jsonl/openai_ ft
"/v1/datasets/{id}/jsonl/openai_ft" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { version_id ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { version_id ?: string | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { version_id ?: string | null } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { id : string }
Optionalquery ?: { version_id ?: string | null }
Optionalversion_id ?: string | null
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/datasets/{id}/versions
"/v1/datasets/{id}/versions" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description : string | null ; metadata : { [ key : string ]: unknown } ; version_id : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description : string | null ; metadata : { [ key : string ]: unknown } ; version_id : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { id : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { id : string }
Optionalquery ?: { cursor ?: string | null ; limit ?: number }
Optionalcursor ?: string | null
Optionallimit ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description : string | null ; metadata : { [ key : string ]: unknown } ; version_id : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { created_at : string ; description : string | null ; metadata : { [ key : string ]: unknown } ; version_id : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/datasets/upload
"/v1/datasets/upload" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { sync ?: boolean } ; } ; requestBody ?: { content : { "application/json" : { action ?: "create" | "append" | "update" ; description ?: string ; example_ids ?: (string | null )[] ; inputs : Record < string , unknown > [] ; metadata ?: Record < string , unknown > [] ; name : string ; outputs ?: Record < string , unknown > [] ; span_ids ?: (string | null )[] ; splits ?: (string | string [] | null )[] ; } ; "multipart/form-data" : { action ?: "create" | "append" | "update" ; description ?: string ; example_id_key ?: string ; file : string ; "flatten_keys[]" ?: string [] ; "input_keys[]" : string [] ; "metadata_keys[]" ?: string [] ; name : string ; "output_keys[]" : string [] ; span_id_key ?: string ; split_key ?: string ; "split_keys[]" ?: string [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : | { data : { dataset_id : string ; num_created_examples : number ; num_deleted_examples : number ; num_updated_examples : number ; version_id : string ; } ; } | null ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "409" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { sync ?: boolean } ; } ; requestBody ?: { content : { "application/json" : { action ?: "create" | "append" | "update" ; description ?: string ; example_ids ?: (string | null )[] ; inputs : Record < string , unknown > [] ; metadata ?: Record < string , unknown > [] ; name : string ; outputs ?: Record < string , unknown > [] ; span_ids ?: (string | null )[] ; splits ?: (string | string [] | null )[] ; } ; "multipart/form-data" : { action ?: "create" | "append" | "update" ; description ?: string ; example_id_key ?: string ; file : string ; "flatten_keys[]" ?: string [] ; "input_keys[]" : string [] ; "metadata_keys[]" ?: string [] ; name : string ; "output_keys[]" : string [] ; span_id_key ?: string ; split_key ?: string ; "split_keys[]" ?: string [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : | { data : { dataset_id : string ; num_created_examples : number ; num_deleted_examples : number ; num_updated_examples : number ; version_id : string ; } ; } | null ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "409" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { sync ?: boolean } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { sync ?: boolean }
OptionalrequestBody ?: { content : { "application/json" : { action ?: "create" | "append" | "update" ; description ?: string ; example_ids ?: (string | null )[] ; inputs : Record < string , unknown > [] ; metadata ?: Record < string , unknown > [] ; name : string ; outputs ?: Record < string , unknown > [] ; span_ids ?: (string | null )[] ; splits ?: (string | string [] | null )[] ; } ; "multipart/form-data" : { action ?: "create" | "append" | "update" ; description ?: string ; example_id_key ?: string ; file : string ; "flatten_keys[]" ?: string [] ; "input_keys[]" : string [] ; "metadata_keys[]" ?: string [] ; name : string ; "output_keys[]" : string [] ; span_id_key ?: string ; split_key ?: string ; "split_keys[]" ?: string [] ; } ; } ; }
responses : { "200" : { content : { "application/json" : | { data : { dataset_id : string ; num_created_examples : number ; num_deleted_examples : number ; num_updated_examples : number ; version_id : string ; } ; } | null ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "409" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : | { data : { dataset_id : string ; num_created_examples : number ; num_deleted_examples : number ; num_updated_examples : number ; version_id : string ; } ; } | null ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
409 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/document_ annotations
"/v1/document_annotations" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { sync ?: boolean } ; } ; requestBody : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; document_position : number ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: string | null ; label ?: string | null ; score ?: number | null ; } | null ; span_id : string ; } [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { sync ?: boolean } ; } ; requestBody : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; document_position : number ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: string | null ; label ?: string | null ; score ?: number | null ; } | null ; span_id : string ; } [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { sync ?: boolean } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { sync ?: boolean }
requestBody : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; document_position : number ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: string | null ; label ?: string | null ; score ?: number | null ; } | null ; span_id : string ; } [] ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/experiment_ evaluations
"/v1/experiment_evaluations" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; end_time : string ; error ?: string | null ; experiment_run_id : string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: string | null ; label ?: string | null ; score ?: number | null ; } | null ; start_time : string ; trace_id ?: string | null ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; end_time : string ; error ?: string | null ; experiment_run_id : string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: string | null ; label ?: string | null ; score ?: number | null ; } | null ; start_time : string ; trace_id ?: string | null ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; end_time : string ; error ?: string | null ; experiment_run_id : string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: string | null ; label ?: string | null ; score ?: number | null ; } | null ; start_time : string ; trace_id ?: string | null ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/experiments/{experiment_ id}
"/v1/experiments/{experiment_id}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: { delete_project ?: boolean } ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { description ?: string | null ; metadata ?: { [ key : string ]: unknown } | null ; name ?: string | null ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: { delete_project ?: boolean } ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: { delete_project ?: boolean } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { experiment_id : string }
Optionalquery ?: { delete_project ?: boolean }
Optionaldelete_project ?: boolean
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: undefined ; }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
patch : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { description ?: string | null ; metadata ?: { [ key : string ]: unknown } | null ; name ?: string | null ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: undefined ; }
requestBody : { content : { "application/json" : { description ?: string | null ; metadata ?: { [ key : string ]: unknown } | null ; name ?: string | null ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { created_at : string ; dataset_id : string ; dataset_version_id : string ; description : string | null ; example_count : number ; failed_run_count : number ; id : string ; metadata : { [ key : string ]: unknown } ; missing_run_count : number ; name : string ; project_name : string | null ; repetitions : number ; successful_run_count : number ; updated_at : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/experiments/{experiment_ id}/csv
"/v1/experiments/{experiment_id}/csv" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown ; "text/csv" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : unknown ; "text/csv" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: undefined ; }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : unknown ; "text/csv" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : unknown ; "text/csv" : string } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/experiments/{experiment_ id}/incomplete- evaluations
"/v1/experiments/{experiment_id}/incomplete-evaluations" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: { cursor ?: string | null ; evaluation_name ?: string [] ; limit ?: number ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { dataset_example : { id : string ; input : { [ key : string ]: unknown } ; metadata : { [ key : string ]: unknown } ; node_id : string ; output : { [ key : string ]: unknown } ; source ?: { span_id : ...; span_node_id : ... } | null ; updated_at : string ; } ; evaluation_names : string [] ; experiment_run : { dataset_example_id : string ; end_time : string ; error ?: string | null ; experiment_id : string ; id : string ; output : unknown ; repetition_number : number ; start_time : string ; trace_id ?: string | null ; } ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: { cursor ?: string | null ; evaluation_name ?: string [] ; limit ?: number ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { dataset_example : { id : string ; input : { [ key : string ]: unknown } ; metadata : { [ key : string ]: unknown } ; node_id : string ; output : { [ key : string ]: unknown } ; source ?: { span_id : ...; span_node_id : ... } | null ; updated_at : string ; } ; evaluation_names : string [] ; experiment_run : { dataset_example_id : string ; end_time : string ; error ?: string | null ; experiment_id : string ; id : string ; output : unknown ; repetition_number : number ; start_time : string ; trace_id ?: string | null ; } ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: { cursor ?: string | null ; evaluation_name ?: string [] ; limit ?: number ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { experiment_id : string }
Optionalquery ?: { cursor ?: string | null ; evaluation_name ?: string [] ; limit ?: number }
Optionalcursor ?: string | null
Optionalevaluation_name ?: string []
Optionallimit ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { dataset_example : { id : string ; input : { [ key : string ]: unknown } ; metadata : { [ key : string ]: unknown } ; node_id : string ; output : { [ key : string ]: unknown } ; source ?: { span_id : ...; span_node_id : ... } | null ; updated_at : string ; } ; evaluation_names : string [] ; experiment_run : { dataset_example_id : string ; end_time : string ; error ?: string | null ; experiment_id : string ; id : string ; output : unknown ; repetition_number : number ; start_time : string ; trace_id ?: string | null ; } ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { dataset_example : { id : string ; input : { [ key : string ]: unknown } ; metadata : { [ key : string ]: unknown } ; node_id : string ; output : { [ key : string ]: unknown } ; source ?: { span_id : ...; span_node_id : ... } | null ; updated_at : string ; } ; evaluation_names : string [] ; experiment_run : { dataset_example_id : string ; end_time : string ; error ?: string | null ; experiment_id : string ; id : string ; output : unknown ; repetition_number : number ; start_time : string ; trace_id ?: string | null ; } ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
400 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/experiments/{experiment_ id}/incomplete- runs
"/v1/experiments/{experiment_id}/incomplete-runs" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { dataset_example : { id : string ; input : { [ key : string ]: unknown } ; metadata : { [ key : string ]: unknown } ; node_id : string ; output : { [ key : string ]: unknown } ; source ?: { span_id : ...; span_node_id : ... } | null ; updated_at : string ; } ; repetition_numbers : number [] ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { dataset_example : { id : string ; input : { [ key : string ]: unknown } ; metadata : { [ key : string ]: unknown } ; node_id : string ; output : { [ key : string ]: unknown } ; source ?: { span_id : ...; span_node_id : ... } | null ; updated_at : string ; } ; repetition_numbers : number [] ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { experiment_id : string }
Optionalquery ?: { cursor ?: string | null ; limit ?: number }
Optionalcursor ?: string | null
Optionallimit ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { dataset_example : { id : string ; input : { [ key : string ]: unknown } ; metadata : { [ key : string ]: unknown } ; node_id : string ; output : { [ key : string ]: unknown } ; source ?: { span_id : ...; span_node_id : ... } | null ; updated_at : string ; } ; repetition_numbers : number [] ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { dataset_example : { id : string ; input : { [ key : string ]: unknown } ; metadata : { [ key : string ]: unknown } ; node_id : string ; output : { [ key : string ]: unknown } ; source ?: { span_id : ...; span_node_id : ... } | null ; updated_at : string ; } ; repetition_numbers : number [] ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/experiments/{experiment_ id}/json
"/v1/experiments/{experiment_id}/json" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: undefined ; }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/experiments/{experiment_ id}/runs
"/v1/experiments/{experiment_id}/runs" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: { cursor ?: string | null ; limit ?: number | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { dataset_example_id : string ; end_time : string ; error ?: string | null ; experiment_id : string ; id : string ; output : unknown ; repetition_number : number ; start_time : string ; trace_id ?: string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { dataset_example_id : string ; end_time : string ; error ?: string | null ; output : unknown ; repetition_number : number ; start_time : string ; trace_id ?: string | null ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "409" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: { cursor ?: string | null ; limit ?: number | null } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { dataset_example_id : string ; end_time : string ; error ?: string | null ; experiment_id : string ; id : string ; output : unknown ; repetition_number : number ; start_time : string ; trace_id ?: string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: { cursor ?: string | null ; limit ?: number | null } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { experiment_id : string }
Optionalquery ?: { cursor ?: string | null ; limit ?: number | null }
Optionalcursor ?: string | null
Optionallimit ?: number | null
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { dataset_example_id : string ; end_time : string ; error ?: string | null ; experiment_id : string ; id : string ; output : unknown ; repetition_number : number ; start_time : string ; trace_id ?: string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { dataset_example_id : string ; end_time : string ; error ?: string | null ; experiment_id : string ; id : string ; output : unknown ; repetition_number : number ; start_time : string ; trace_id ?: string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { dataset_example_id : string ; end_time : string ; error ?: string | null ; output : unknown ; repetition_number : number ; start_time : string ; trace_id ?: string | null ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "409" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { experiment_id : string } ; query ?: undefined ; }
requestBody : { content : { "application/json" : { dataset_example_id : string ; end_time : string ; error ?: string | null ; output : unknown ; repetition_number : number ; start_time : string ; trace_id ?: string | null ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "409" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
409 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/projects
"/v1/projects" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; include_dataset_evaluator_projects ?: boolean ; include_experiment_projects ?: boolean ; limit ?: number ; name_contains ?: string | null ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { description ?: string | null ; name : string } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; include_dataset_evaluator_projects ?: boolean ; include_experiment_projects ?: boolean ; limit ?: number ; name_contains ?: string | null ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; include_dataset_evaluator_projects ?: boolean ; include_experiment_projects ?: boolean ; limit ?: number ; name_contains ?: string | null ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { cursor ?: string | null ; include_dataset_evaluator_projects ?: boolean ; include_experiment_projects ?: boolean ; limit ?: number ; name_contains ?: string | null ; }
Optionalcursor ?: string | null
Optionalinclude_dataset_evaluator_projects ?: boolean
Optionalinclude_experiment_projects ?: boolean
Optionallimit ?: number
Optionalname_contains ?: string | null
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { description ?: string | null ; name : string } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : { description ?: string | null ; name : string } ; } ; }
responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/projects/{project_ identifier}
"/v1/projects/{project_identifier}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { description ?: string | null } } ; } ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { description ?: string | null } } ; } ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: undefined
requestBody : { content : { "application/json" : { description ?: string | null } } }
responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionaltrace ?: undefined
/v1/projects/{project_ identifier}/annotation_ configs
"/v1/projects/{project_identifier}/annotation_configs" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : ( | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : ...; score ?: ... } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { annotation_config_ids : string [] } } ; } ; responses : { "200" : { content : { "application/json" : { data : ( | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : ...; score ?: ... } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : ( | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : ...; score ?: ... } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: { cursor ?: string | null ; limit ?: number }
Optionalcursor ?: string | null
Optionallimit ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : ( | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : ...; score ?: ... } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : ( | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : ...; score ?: ... } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { annotation_config_ids : string [] } } ; } ; responses : { "200" : { content : { "application/json" : { data : ( | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : ...; score ?: ... } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: undefined
requestBody : { content : { "application/json" : { annotation_config_ids : string [] } } }
responses : { "200" : { content : { "application/json" : { data : ( | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : ...; score ?: ... } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : ( | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : ...; score ?: ... } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionaltrace ?: undefined
/v1/projects/{project_ identifier}/annotation_ configs/{config_ identifier}
"/v1/projects/{project_identifier}/annotation_configs/{config_identifier}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { config_identifier : string ; project_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { config_identifier : string ; project_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { config_identifier : string ; project_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { config_identifier : string ; project_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { config_identifier : string ; project_identifier : string }
config_identifier : string
project_identifier : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
put : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { config_identifier : string ; project_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { config_identifier : string ; project_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { config_identifier : string ; project_identifier : string }
config_identifier : string
project_identifier : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : | { description ?: string | null ; id : string ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CATEGORICAL" ; values : { label : string ; score ?: (...) | (...) | (...) } [] ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction : "MINIMIZE" | "MAXIMIZE" | "NONE" ; type : "CONTINUOUS" ; upper_bound ?: number | null ; } | { description ?: string | null ; id : string ; lower_bound ?: number | null ; name : string ; optimization_direction ?: "MINIMIZE" | "MAXIMIZE" | "NONE" | null ; threshold ?: number | null ; type : "FREEFORM" ; upper_bound ?: number | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionaltrace ?: undefined
/v1/projects/{project_ identifier}/session_ annotations
"/v1/projects/{project_identifier}/session_annotations" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { annotator_kind ?: "LLM" | "CODE" | "HUMAN" | null ; delete_all ?: boolean ; end_time ?: string | null ; identifier ?: string | null ; name ?: string | null ; start_time ?: string | null ; } ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; exclude_annotation_names ?: string [] | null ; identifier ?: string [] | null ; include_annotation_names ?: string [] | null ; limit ?: number ; session_ids ?: string [] | null ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; created_at : string ; id : string ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: (...) | (...) | (...); label ?: (...) | (...) | (...); score ?: (...) | (...) | (...); } | null ; session_id : string ; source : "API" | "APP" ; updated_at : string ; user_id : string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { annotator_kind ?: "LLM" | "CODE" | "HUMAN" | null ; delete_all ?: boolean ; end_time ?: string | null ; identifier ?: string | null ; name ?: string | null ; start_time ?: string | null ; } ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { annotator_kind ?: "LLM" | "CODE" | "HUMAN" | null ; delete_all ?: boolean ; end_time ?: string | null ; identifier ?: string | null ; name ?: string | null ; start_time ?: string | null ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: { annotator_kind ?: "LLM" | "CODE" | "HUMAN" | null ; delete_all ?: boolean ; end_time ?: string | null ; identifier ?: string | null ; name ?: string | null ; start_time ?: string | null ; }
Optionalannotator_kind ?: "LLM" | "CODE" | "HUMAN" | null
Optionaldelete_all ?: boolean
Optionalend_time ?: string | null
Optionalidentifier ?: string | null
Optionalname ?: string | null
Optionalstart_time ?: string | null
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; exclude_annotation_names ?: string [] | null ; identifier ?: string [] | null ; include_annotation_names ?: string [] | null ; limit ?: number ; session_ids ?: string [] | null ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; created_at : string ; id : string ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: (...) | (...) | (...); label ?: (...) | (...) | (...); score ?: (...) | (...) | (...); } | null ; session_id : string ; source : "API" | "APP" ; updated_at : string ; user_id : string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; exclude_annotation_names ?: string [] | null ; identifier ?: string [] | null ; include_annotation_names ?: string [] | null ; limit ?: number ; session_ids ?: string [] | null ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: { cursor ?: string | null ; exclude_annotation_names ?: string [] | null ; identifier ?: string [] | null ; include_annotation_names ?: string [] | null ; limit ?: number ; session_ids ?: string [] | null ; }
Optionalcursor ?: string | null
Optionalexclude_annotation_names ?: string [] | null
Optionalidentifier ?: string [] | null
Optionalinclude_annotation_names ?: string [] | null
Optionallimit ?: number
Optionalsession_ids ?: string [] | null
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; created_at : string ; id : string ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: (...) | (...) | (...); label ?: (...) | (...) | (...); score ?: (...) | (...) | (...); } | null ; session_id : string ; source : "API" | "APP" ; updated_at : string ; user_id : string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; created_at : string ; id : string ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: (...) | (...) | (...); label ?: (...) | (...) | (...); score ?: (...) | (...) | (...); } | null ; session_id : string ; source : "API" | "APP" ; updated_at : string ; user_id : string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/projects/{project_ identifier}/sessions
"/v1/projects/{project_identifier}/sessions" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; limit ?: number ; order ?: "asc" | "desc" ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { end_time : string ; id : string ; project_id : string ; session_id : string ; start_time : string ; token_count_completion ?: number ; token_count_prompt ?: number ; token_count_total ?: number ; traces : { end_time : string ; id : string ; start_time : string ; trace_id : string ; } [] ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; limit ?: number ; order ?: "asc" | "desc" } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { end_time : string ; id : string ; project_id : string ; session_id : string ; start_time : string ; token_count_completion ?: number ; token_count_prompt ?: number ; token_count_total ?: number ; traces : { end_time : string ; id : string ; start_time : string ; trace_id : string ; } [] ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; limit ?: number ; order ?: "asc" | "desc" } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: { cursor ?: string | null ; limit ?: number ; order ?: "asc" | "desc" }
Optionalcursor ?: string | null
Optionallimit ?: number
Optionalorder ?: "asc" | "desc"
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { end_time : string ; id : string ; project_id : string ; session_id : string ; start_time : string ; token_count_completion ?: number ; token_count_prompt ?: number ; token_count_total ?: number ; traces : { end_time : string ; id : string ; start_time : string ; trace_id : string ; } [] ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { end_time : string ; id : string ; project_id : string ; session_id : string ; start_time : string ; token_count_completion ?: number ; token_count_prompt ?: number ; token_count_total ?: number ; traces : { end_time : string ; id : string ; start_time : string ; trace_id : string ; } [] ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/projects/{project_ identifier}/span_ annotations
"/v1/projects/{project_identifier}/span_annotations" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { annotator_kind ?: "LLM" | "CODE" | "HUMAN" | null ; delete_all ?: boolean ; end_time ?: string | null ; identifier ?: string | null ; name ?: string | null ; start_time ?: string | null ; } ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; exclude_annotation_names ?: string [] | null ; identifier ?: string [] | null ; include_annotation_names ?: string [] | null ; limit ?: number ; span_ids ?: string [] | null ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; created_at : string ; id : string ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: (...) | (...) | (...); label ?: (...) | (...) | (...); score ?: (...) | (...) | (...); } | null ; source : "API" | "APP" ; span_id : string ; updated_at : string ; user_id : string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { annotator_kind ?: "LLM" | "CODE" | "HUMAN" | null ; delete_all ?: boolean ; end_time ?: string | null ; identifier ?: string | null ; name ?: string | null ; start_time ?: string | null ; } ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { annotator_kind ?: "LLM" | "CODE" | "HUMAN" | null ; delete_all ?: boolean ; end_time ?: string | null ; identifier ?: string | null ; name ?: string | null ; start_time ?: string | null ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: { annotator_kind ?: "LLM" | "CODE" | "HUMAN" | null ; delete_all ?: boolean ; end_time ?: string | null ; identifier ?: string | null ; name ?: string | null ; start_time ?: string | null ; }
Optionalannotator_kind ?: "LLM" | "CODE" | "HUMAN" | null
Optionaldelete_all ?: boolean
Optionalend_time ?: string | null
Optionalidentifier ?: string | null
Optionalname ?: string | null
Optionalstart_time ?: string | null
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; exclude_annotation_names ?: string [] | null ; identifier ?: string [] | null ; include_annotation_names ?: string [] | null ; limit ?: number ; span_ids ?: string [] | null ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; created_at : string ; id : string ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: (...) | (...) | (...); label ?: (...) | (...) | (...); score ?: (...) | (...) | (...); } | null ; source : "API" | "APP" ; span_id : string ; updated_at : string ; user_id : string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; exclude_annotation_names ?: string [] | null ; identifier ?: string [] | null ; include_annotation_names ?: string [] | null ; limit ?: number ; span_ids ?: string [] | null ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: { cursor ?: string | null ; exclude_annotation_names ?: string [] | null ; identifier ?: string [] | null ; include_annotation_names ?: string [] | null ; limit ?: number ; span_ids ?: string [] | null ; }
Optionalcursor ?: string | null
Optionalexclude_annotation_names ?: string [] | null
Optionalidentifier ?: string [] | null
Optionalinclude_annotation_names ?: string [] | null
Optionallimit ?: number
Optionalspan_ids ?: string [] | null
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; created_at : string ; id : string ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: (...) | (...) | (...); label ?: (...) | (...) | (...); score ?: (...) | (...) | (...); } | null ; source : "API" | "APP" ; span_id : string ; updated_at : string ; user_id : string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; created_at : string ; id : string ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: (...) | (...) | (...); label ?: (...) | (...) | (...); score ?: (...) | (...) | (...); } | null ; source : "API" | "APP" ; span_id : string ; updated_at : string ; user_id : string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/projects/{project_ identifier}/spans
"/v1/projects/{project_identifier}/spans" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { attribute ?: string [] | null ; cursor ?: string | null ; end_time ?: string | null ; limit ?: number ; name ?: string [] | null ; parent_id ?: string | null ; span_id ?: string [] | null ; span_kind ?: string [] | null ; start_time ?: string | null ; status_code ?: string [] | null ; trace_id ?: string [] | null ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { attributes ?: { [ key : string ]: unknown } ; context : { span_id : string ; trace_id : string } ; end_time : string ; events ?: { attributes ?: ...; name : ...; timestamp : ... } [] ; id ?: string ; name : string ; parent_id ?: string | null ; span_kind : string ; start_time : string ; status_code : string ; status_message ?: string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { data : { attributes ?: { [ key : string ]: unknown } ; context : { span_id : string ; trace_id : string } ; end_time : string ; events ?: { attributes ?: (...) | (...); name : string ; timestamp : string ; } [] ; id ?: string ; name : string ; parent_id ?: string | null ; span_kind : string ; start_time : string ; status_code : string ; status_message ?: string ; } [] ; } ; } ; } ; responses : { "202" : { content : { "application/json" : { total_queued : number ; total_received : number } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { attribute ?: string [] | null ; cursor ?: string | null ; end_time ?: string | null ; limit ?: number ; name ?: string [] | null ; parent_id ?: string | null ; span_id ?: string [] | null ; span_kind ?: string [] | null ; start_time ?: string | null ; status_code ?: string [] | null ; trace_id ?: string [] | null ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { attributes ?: { [ key : string ]: unknown } ; context : { span_id : string ; trace_id : string } ; end_time : string ; events ?: { attributes ?: ...; name : ...; timestamp : ... } [] ; id ?: string ; name : string ; parent_id ?: string | null ; span_kind : string ; start_time : string ; status_code : string ; status_message ?: string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { attribute ?: string [] | null ; cursor ?: string | null ; end_time ?: string | null ; limit ?: number ; name ?: string [] | null ; parent_id ?: string | null ; span_id ?: string [] | null ; span_kind ?: string [] | null ; start_time ?: string | null ; status_code ?: string [] | null ; trace_id ?: string [] | null ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: { attribute ?: string [] | null ; cursor ?: string | null ; end_time ?: string | null ; limit ?: number ; name ?: string [] | null ; parent_id ?: string | null ; span_id ?: string [] | null ; span_kind ?: string [] | null ; start_time ?: string | null ; status_code ?: string [] | null ; trace_id ?: string [] | null ; }
Optionalattribute ?: string [] | null
Optionalcursor ?: string | null
Optionalend_time ?: string | null
Optionallimit ?: number
Optionalname ?: string [] | null
Optionalparent_id ?: string | null
Optionalspan_id ?: string [] | null
Optionalspan_kind ?: string [] | null
Optionalstart_time ?: string | null
Optionalstatus_code ?: string [] | null
Optionaltrace_id ?: string [] | null
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { attributes ?: { [ key : string ]: unknown } ; context : { span_id : string ; trace_id : string } ; end_time : string ; events ?: { attributes ?: ...; name : ...; timestamp : ... } [] ; id ?: string ; name : string ; parent_id ?: string | null ; span_kind : string ; start_time : string ; status_code : string ; status_message ?: string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { attributes ?: { [ key : string ]: unknown } ; context : { span_id : string ; trace_id : string } ; end_time : string ; events ?: { attributes ?: ...; name : ...; timestamp : ... } [] ; id ?: string ; name : string ; parent_id ?: string | null ; span_kind : string ; start_time : string ; status_code : string ; status_message ?: string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { data : { attributes ?: { [ key : string ]: unknown } ; context : { span_id : string ; trace_id : string } ; end_time : string ; events ?: { attributes ?: (...) | (...); name : string ; timestamp : string ; } [] ; id ?: string ; name : string ; parent_id ?: string | null ; span_kind : string ; start_time : string ; status_code : string ; status_message ?: string ; } [] ; } ; } ; } ; responses : { "202" : { content : { "application/json" : { total_queued : number ; total_received : number } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: undefined
requestBody : { content : { "application/json" : { data : { attributes ?: { [ key : string ]: unknown } ; context : { span_id : string ; trace_id : string } ; end_time : string ; events ?: { attributes ?: (...) | (...); name : string ; timestamp : string } [] ; id ?: string ; name : string ; parent_id ?: string | null ; span_kind : string ; start_time : string ; status_code : string ; status_message ?: string ; } [] ; } ; } ; }
responses : { "202" : { content : { "application/json" : { total_queued : number ; total_received : number } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
202 : { content : { "application/json" : { total_queued : number ; total_received : number } ; } ; headers : { [ name : string ]: unknown } ; }
400 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/projects/{project_ identifier}/spans/otlpv1
"/v1/projects/{project_identifier}/spans/otlpv1" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { attribute ?: string [] | null ; cursor ?: string | null ; end_time ?: string | null ; limit ?: number ; name ?: string [] | null ; parent_id ?: string | null ; span_id ?: string [] | null ; start_time ?: string | null ; status_code ?: string [] | null ; trace_id ?: string [] | null ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { attributes ?: { key ?: ...; value ?: ... } [] | null ; dropped_attributes_count ?: number | null ; dropped_events_count ?: number | null ; dropped_links_count ?: number | null ; end_time_unix_nano ?: string | number | null ; events ?: | { attributes ?: ...; dropped_attributes_count ?: ...; name ?: ...; time_unix_nano ?: ...; } [] | null ; flags ?: number | null ; kind ?: | number | "SPAN_KIND_UNSPECIFIED" | "SPAN_KIND_INTERNAL" | "SPAN_KIND_SERVER" | "SPAN_KIND_CLIENT" | "SPAN_KIND_PRODUCER" | "SPAN_KIND_CONSUMER" | null ; links ?: null ; name ?: string | null ; parent_span_id ?: string | null ; span_id ?: string | null ; start_time_unix_nano ?: string | number | null ; status ?: | { code ?: (...) | (...) | (...); message ?: (...) | (...) | (...); } | null ; trace_id ?: string | null ; trace_state ?: string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { attribute ?: string [] | null ; cursor ?: string | null ; end_time ?: string | null ; limit ?: number ; name ?: string [] | null ; parent_id ?: string | null ; span_id ?: string [] | null ; start_time ?: string | null ; status_code ?: string [] | null ; trace_id ?: string [] | null ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { attributes ?: { key ?: ...; value ?: ... } [] | null ; dropped_attributes_count ?: number | null ; dropped_events_count ?: number | null ; dropped_links_count ?: number | null ; end_time_unix_nano ?: string | number | null ; events ?: | { attributes ?: ...; dropped_attributes_count ?: ...; name ?: ...; time_unix_nano ?: ...; } [] | null ; flags ?: number | null ; kind ?: | number | "SPAN_KIND_UNSPECIFIED" | "SPAN_KIND_INTERNAL" | "SPAN_KIND_SERVER" | "SPAN_KIND_CLIENT" | "SPAN_KIND_PRODUCER" | "SPAN_KIND_CONSUMER" | null ; links ?: null ; name ?: string | null ; parent_span_id ?: string | null ; span_id ?: string | null ; start_time_unix_nano ?: string | number | null ; status ?: | { code ?: (...) | (...) | (...); message ?: (...) | (...) | (...); } | null ; trace_id ?: string | null ; trace_state ?: string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { attribute ?: string [] | null ; cursor ?: string | null ; end_time ?: string | null ; limit ?: number ; name ?: string [] | null ; parent_id ?: string | null ; span_id ?: string [] | null ; start_time ?: string | null ; status_code ?: string [] | null ; trace_id ?: string [] | null ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: { attribute ?: string [] | null ; cursor ?: string | null ; end_time ?: string | null ; limit ?: number ; name ?: string [] | null ; parent_id ?: string | null ; span_id ?: string [] | null ; start_time ?: string | null ; status_code ?: string [] | null ; trace_id ?: string [] | null ; }
Optionalattribute ?: string [] | null
Optionalcursor ?: string | null
Optionalend_time ?: string | null
Optionallimit ?: number
Optionalname ?: string [] | null
Optionalparent_id ?: string | null
Optionalspan_id ?: string [] | null
Optionalstart_time ?: string | null
Optionalstatus_code ?: string [] | null
Optionaltrace_id ?: string [] | null
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { attributes ?: { key ?: ...; value ?: ... } [] | null ; dropped_attributes_count ?: number | null ; dropped_events_count ?: number | null ; dropped_links_count ?: number | null ; end_time_unix_nano ?: string | number | null ; events ?: | { attributes ?: ...; dropped_attributes_count ?: ...; name ?: ...; time_unix_nano ?: ...; } [] | null ; flags ?: number | null ; kind ?: | number | "SPAN_KIND_UNSPECIFIED" | "SPAN_KIND_INTERNAL" | "SPAN_KIND_SERVER" | "SPAN_KIND_CLIENT" | "SPAN_KIND_PRODUCER" | "SPAN_KIND_CONSUMER" | null ; links ?: null ; name ?: string | null ; parent_span_id ?: string | null ; span_id ?: string | null ; start_time_unix_nano ?: string | number | null ; status ?: | { code ?: (...) | (...) | (...); message ?: (...) | (...) | (...) } | null ; trace_id ?: string | null ; trace_state ?: string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { attributes ?: { key ?: ...; value ?: ... } [] | null ; dropped_attributes_count ?: number | null ; dropped_events_count ?: number | null ; dropped_links_count ?: number | null ; end_time_unix_nano ?: string | number | null ; events ?: | { attributes ?: ...; dropped_attributes_count ?: ...; name ?: ...; time_unix_nano ?: ...; } [] | null ; flags ?: number | null ; kind ?: | number | "SPAN_KIND_UNSPECIFIED" | "SPAN_KIND_INTERNAL" | "SPAN_KIND_SERVER" | "SPAN_KIND_CLIENT" | "SPAN_KIND_PRODUCER" | "SPAN_KIND_CONSUMER" | null ; links ?: null ; name ?: string | null ; parent_span_id ?: string | null ; span_id ?: string | null ; start_time_unix_nano ?: string | number | null ; status ?: | { code ?: (...) | (...) | (...); message ?: (...) | (...) | (...) } | null ; trace_id ?: string | null ; trace_state ?: string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/projects/{project_ identifier}/trace_ annotations
"/v1/projects/{project_identifier}/trace_annotations" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { annotator_kind ?: "LLM" | "CODE" | "HUMAN" | null ; delete_all ?: boolean ; end_time ?: string | null ; identifier ?: string | null ; name ?: string | null ; start_time ?: string | null ; } ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; exclude_annotation_names ?: string [] | null ; identifier ?: string [] | null ; include_annotation_names ?: string [] | null ; limit ?: number ; trace_ids ?: string [] | null ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; created_at : string ; id : string ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: (...) | (...) | (...); label ?: (...) | (...) | (...); score ?: (...) | (...) | (...); } | null ; source : "API" | "APP" ; trace_id : string ; updated_at : string ; user_id : string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { annotator_kind ?: "LLM" | "CODE" | "HUMAN" | null ; delete_all ?: boolean ; end_time ?: string | null ; identifier ?: string | null ; name ?: string | null ; start_time ?: string | null ; } ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { annotator_kind ?: "LLM" | "CODE" | "HUMAN" | null ; delete_all ?: boolean ; end_time ?: string | null ; identifier ?: string | null ; name ?: string | null ; start_time ?: string | null ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: { annotator_kind ?: "LLM" | "CODE" | "HUMAN" | null ; delete_all ?: boolean ; end_time ?: string | null ; identifier ?: string | null ; name ?: string | null ; start_time ?: string | null ; }
Optionalannotator_kind ?: "LLM" | "CODE" | "HUMAN" | null
Optionaldelete_all ?: boolean
Optionalend_time ?: string | null
Optionalidentifier ?: string | null
Optionalname ?: string | null
Optionalstart_time ?: string | null
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; exclude_annotation_names ?: string [] | null ; identifier ?: string [] | null ; include_annotation_names ?: string [] | null ; limit ?: number ; trace_ids ?: string [] | null ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; created_at : string ; id : string ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: (...) | (...) | (...); label ?: (...) | (...) | (...); score ?: (...) | (...) | (...); } | null ; source : "API" | "APP" ; trace_id : string ; updated_at : string ; user_id : string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; exclude_annotation_names ?: string [] | null ; identifier ?: string [] | null ; include_annotation_names ?: string [] | null ; limit ?: number ; trace_ids ?: string [] | null ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: { cursor ?: string | null ; exclude_annotation_names ?: string [] | null ; identifier ?: string [] | null ; include_annotation_names ?: string [] | null ; limit ?: number ; trace_ids ?: string [] | null ; }
Optionalcursor ?: string | null
Optionalexclude_annotation_names ?: string [] | null
Optionalidentifier ?: string [] | null
Optionalinclude_annotation_names ?: string [] | null
Optionallimit ?: number
Optionaltrace_ids ?: string [] | null
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; created_at : string ; id : string ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: (...) | (...) | (...); label ?: (...) | (...) | (...); score ?: (...) | (...) | (...); } | null ; source : "API" | "APP" ; trace_id : string ; updated_at : string ; user_id : string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; created_at : string ; id : string ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: (...) | (...) | (...); label ?: (...) | (...) | (...); score ?: (...) | (...) | (...); } | null ; source : "API" | "APP" ; trace_id : string ; updated_at : string ; user_id : string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/projects/{project_ identifier}/traces
"/v1/projects/{project_identifier}/traces" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; end_time ?: string | null ; include_spans ?: boolean ; limit ?: number ; order ?: "asc" | "desc" ; session_identifier ?: string [] | null ; sort ?: "start_time" | "latency_ms" ; start_time ?: string | null ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { end_time : string ; id : string ; project_id : string ; spans ?: | { end_time : ...; id : ...; name : ...; parent_id : ...; span_id : ...; span_kind : ...; start_time : ...; status_code : ...; } [] | null ; start_time : string ; token_count_completion ?: number ; token_count_prompt ?: number ; token_count_total ?: number ; trace_id : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; end_time ?: string | null ; include_spans ?: boolean ; limit ?: number ; order ?: "asc" | "desc" ; session_identifier ?: string [] | null ; sort ?: "start_time" | "latency_ms" ; start_time ?: string | null ; } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { end_time : string ; id : string ; project_id : string ; spans ?: | { end_time : ...; id : ...; name : ...; parent_id : ...; span_id : ...; span_kind : ...; start_time : ...; status_code : ...; } [] | null ; start_time : string ; token_count_completion ?: number ; token_count_prompt ?: number ; token_count_total ?: number ; trace_id : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { project_identifier : string } ; query ?: { cursor ?: string | null ; end_time ?: string | null ; include_spans ?: boolean ; limit ?: number ; order ?: "asc" | "desc" ; session_identifier ?: string [] | null ; sort ?: "start_time" | "latency_ms" ; start_time ?: string | null ; } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { project_identifier : string }
project_identifier : string
Optionalquery ?: { cursor ?: string | null ; end_time ?: string | null ; include_spans ?: boolean ; limit ?: number ; order ?: "asc" | "desc" ; session_identifier ?: string [] | null ; sort ?: "start_time" | "latency_ms" ; start_time ?: string | null ; }
Optionalcursor ?: string | null
Optionalend_time ?: string | null
Optionalinclude_spans ?: boolean
Optionallimit ?: number
Optionalorder ?: "asc" | "desc"
Optionalsession_identifier ?: string [] | null
Optionalsort ?: "start_time" | "latency_ms"
Optionalstart_time ?: string | null
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { end_time : string ; id : string ; project_id : string ; spans ?: | { end_time : ...; id : ...; name : ...; parent_id : ...; span_id : ...; span_kind : ...; start_time : ...; status_code : ...; } [] | null ; start_time : string ; token_count_completion ?: number ; token_count_prompt ?: number ; token_count_total ?: number ; trace_id : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { end_time : string ; id : string ; project_id : string ; spans ?: | { end_time : ...; id : ...; name : ...; parent_id : ...; span_id : ...; span_kind : ...; start_time : ...; status_code : ...; } [] | null ; start_time : string ; token_count_completion ?: number ; token_count_prompt ?: number ; token_count_total ?: number ; trace_id : string ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/prompt_ versions/{prompt_ version_ id}
"/v1/prompt_versions/{prompt_version_id}" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_version_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_version_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_version_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { prompt_version_id : string }
prompt_version_id : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
"/v1/prompt_versions/{prompt_version_id}/tags" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_version_id : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_version_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { description ?: string | null ; name : string } ; } ; } ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_version_id : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_version_id : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { prompt_version_id : string }
prompt_version_id : string
Optionalquery ?: { cursor ?: string | null ; limit ?: number }
Optionalcursor ?: string | null
Optionallimit ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { description ?: string | null ; id : string ; name : string } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_version_id : string } ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { description ?: string | null ; name : string } ; } ; } ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_version_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { prompt_version_id : string }
prompt_version_id : string
Optionalquery ?: undefined
requestBody : { content : { "application/json" : { description ?: string | null ; name : string } ; } ; }
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
"/v1/prompt_versions/{prompt_version_id}/tags/{tag_name}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_version_id : string ; tag_name : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_version_id : string ; tag_name : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_version_id : string ; tag_name : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { prompt_version_id : string ; tag_name : string }
prompt_version_id : string
tag_name : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/prompts
"/v1/prompts" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; source_prompt_id ?: string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { prompt : { description ?: string | null ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; source_prompt_id ?: string | null ; } ; version : { description ?: string | null ; invocation_parameters : | { anthropic : { extra_body ?: { [ key : ...]: ... } ; max_tokens : number ; output_config ?: { effort ?: ... } ; stop_sequences ?: (...)[] ; temperature ?: number ; thinking ?: | { type : ... } | { budget_tokens : ...; display ?: ...; type : ... } | { display ?: ...; type : ... } ; top_p ?: number ; } ; type : "anthropic" ; } | { aws : { max_tokens ?: number ; stop_sequences ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "aws" ; } | { azure_openai : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "cerebras" ; } | { deepseek : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "deepseek" ; } | { fireworks : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "fireworks" ; } | { google : { frequency_penalty ?: number ; max_output_tokens ?: number ; presence_penalty ?: number ; stop_sequences ?: (...)[] ; temperature ?: number ; thinking_config ?: { include_thoughts ?: ...; thinking_budget ?: ...; thinking_level ?: ...; } ; top_k ?: number ; top_p ?: number ; } ; type : "google" ; } | { groq : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "groq" ; } | { moonshot : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "moonshot" ; } | { ollama : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "ollama" ; } | { openai : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "openai" ; } | { perplexity : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "perplexity" ; } | { together : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: string ; name : string ; schema ?: { [ key : ...]: ... } ; strict ?: boolean ; } ; type : "json_schema" ; } | null ; template : | { messages : { content : (...) | (...); role : (...) | (...) | (...) | (...) | (...) | (...) | (...); } [] ; type : "chat" ; } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : "none" } | { type : "one_or_more" } | { function_name : string ; type : "specific_function" } | { type : "zero_or_more" } ; tools : ({ function : ...; type : ... } | { raw : ...; type : ... } )[] ; type : "tools" ; } | null ; } ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; source_prompt_id ?: string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; limit ?: number } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { cursor ?: string | null ; limit ?: number }
Optionalcursor ?: string | null
Optionallimit ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; source_prompt_id ?: string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { description ?: string | null ; id : string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; source_prompt_id ?: string | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { prompt : { description ?: string | null ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; source_prompt_id ?: string | null ; } ; version : { description ?: string | null ; invocation_parameters : | { anthropic : { extra_body ?: { [ key : ...]: ... } ; max_tokens : number ; output_config ?: { effort ?: ... } ; stop_sequences ?: (...)[] ; temperature ?: number ; thinking ?: | { type : ... } | { budget_tokens : ...; display ?: ...; type : ... } | { display ?: ...; type : ... } ; top_p ?: number ; } ; type : "anthropic" ; } | { aws : { max_tokens ?: number ; stop_sequences ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "aws" ; } | { azure_openai : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "cerebras" ; } | { deepseek : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "deepseek" ; } | { fireworks : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "fireworks" ; } | { google : { frequency_penalty ?: number ; max_output_tokens ?: number ; presence_penalty ?: number ; stop_sequences ?: (...)[] ; temperature ?: number ; thinking_config ?: { include_thoughts ?: ...; thinking_budget ?: ...; thinking_level ?: ...; } ; top_k ?: number ; top_p ?: number ; } ; type : "google" ; } | { groq : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "groq" ; } | { moonshot : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "moonshot" ; } | { ollama : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "ollama" ; } | { openai : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "openai" ; } | { perplexity : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "perplexity" ; } | { together : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: string ; name : string ; schema ?: { [ key : ...]: ... } ; strict ?: boolean ; } ; type : "json_schema" ; } | null ; template : | { messages : { content : (...) | (...); role : (...) | (...) | (...) | (...) | (...) | (...) | (...); } [] ; type : "chat" ; } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : "none" } | { type : "one_or_more" } | { function_name : string ; type : "specific_function" } | { type : "zero_or_more" } ; tools : ({ function : ...; type : ... } | { raw : ...; type : ... } )[] ; type : "tools" ; } | null ; } ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : { prompt : { description ?: string | null ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; source_prompt_id ?: string | null ; } ; version : { description ?: string | null ; invocation_parameters : | { anthropic : { extra_body ?: { [ key : ...]: ... } ; max_tokens : number ; output_config ?: { effort ?: ... } ; stop_sequences ?: (...)[] ; temperature ?: number ; thinking ?: | { type : ... } | { budget_tokens : ...; display ?: ...; type : ... } | { display ?: ...; type : ... } ; top_p ?: number ; } ; type : "anthropic" ; } | { aws : { max_tokens ?: number ; stop_sequences ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "aws" ; } | { azure_openai : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "cerebras" ; } | { deepseek : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "deepseek" ; } | { fireworks : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "fireworks" ; } | { google : { frequency_penalty ?: number ; max_output_tokens ?: number ; presence_penalty ?: number ; stop_sequences ?: (...)[] ; temperature ?: number ; thinking_config ?: { include_thoughts ?: ...; thinking_budget ?: ...; thinking_level ?: ...; } ; top_k ?: number ; top_p ?: number ; } ; type : "google" ; } | { groq : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "groq" ; } | { moonshot : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "moonshot" ; } | { ollama : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "ollama" ; } | { openai : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "openai" ; } | { perplexity : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "perplexity" ; } | { together : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: { [ key : ...]: ... } ; frequency_penalty ?: number ; max_completion_tokens ?: number ; max_tokens ?: number ; presence_penalty ?: number ; reasoning_effort ?: | "low" | "medium" | "high" | "xhigh" | "none" | "minimal" ; seed ?: number ; stop ?: (...)[] ; temperature ?: number ; top_p ?: number ; } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: string ; name : string ; schema ?: { [ key : ...]: ... } ; strict ?: boolean ; } ; type : "json_schema" ; } | null ; template : | { messages : { content : (...) | (...); role : (...) | (...) | (...) | (...) | (...) | (...) | (...); } [] ; type : "chat" ; } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : "none" } | { type : "one_or_more" } | { function_name : string ; type : "specific_function" } | { type : "zero_or_more" } ; tools : ({ function : ...; type : ... } | { raw : ...; type : ... } )[] ; type : "tools" ; } | null ; } ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/prompts/{prompt_ identifier}
"/v1/prompts/{prompt_identifier}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { prompt_identifier : string }
prompt_identifier : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/prompts/{prompt_ identifier}/latest
"/v1/prompts/{prompt_identifier}/latest" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { prompt_identifier : string }
prompt_identifier : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
"/v1/prompts/{prompt_identifier}/tags/{tag_name}" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_identifier : string ; tag_name : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_identifier : string ; tag_name : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_identifier : string ; tag_name : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { prompt_identifier : string ; tag_name : string }
prompt_identifier : string
tag_name : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: (...) | (...); max_tokens : number ; output_config ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking ?: (...) | (...) | (...) | (...); top_p ?: (...) | (...); } ; type : "anthropic" ; } | { aws : { max_tokens ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "aws" ; } | { azure_openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "cerebras" ; } | { deepseek : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "deepseek" ; } | { fireworks : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "fireworks" ; } | { google : { frequency_penalty ?: (...) | (...); max_output_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); stop_sequences ?: (...) | (...); temperature ?: (...) | (...); thinking_config ?: (...) | (...); top_k ?: (...) | (...); top_p ?: (...) | (...); } ; type : "google" ; } | { groq : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "groq" ; } | { moonshot : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "moonshot" ; } | { ollama : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "ollama" ; } | { openai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "openai" ; } | { perplexity : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "perplexity" ; } | { together : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: (...) | (...); frequency_penalty ?: (...) | (...); max_completion_tokens ?: (...) | (...); max_tokens ?: (...) | (...); presence_penalty ?: (...) | (...); reasoning_effort ?: | (...) | (...) | (...) | (...) | (...) | (...) | (...); seed ?: (...) | (...); stop ?: (...) | (...); temperature ?: (...) | (...); top_p ?: (...) | (...); } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: (...) | (...); name : string ; schema ?: (...) | (...); strict ?: (...) | (...) | (...); } ; type : "json_schema" ; } | null ; template : | { messages : { content : ...; role : ... } [] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: boolean ; tool_choice ?: | { type : ... } | { type : ... } | { function_name : ...; type : ... } | { type : ... } ; tools : ((...) | (...))[] ; type : "tools" ; } | null ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/prompts/{prompt_ identifier}/versions
"/v1/prompts/{prompt_identifier}/versions" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_identifier : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: ...; max_tokens : ...; output_config ?: ...; stop_sequences ?: ...; temperature ?: ...; thinking ?: ...; top_p ?: ...; } ; type : "anthropic" ; } | { aws : { max_tokens ?: ...; stop_sequences ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "aws" ; } | { azure_openai : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "cerebras" ; } | { deepseek : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "deepseek" ; } | { fireworks : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "fireworks" ; } | { google : { frequency_penalty ?: ...; max_output_tokens ?: ...; presence_penalty ?: ...; stop_sequences ?: ...; temperature ?: ...; thinking_config ?: ...; top_k ?: ...; top_p ?: ...; } ; type : "google" ; } | { groq : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "groq" ; } | { moonshot : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "moonshot" ; } | { ollama : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "ollama" ; } | { openai : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "openai" ; } | { perplexity : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "perplexity" ; } | { together : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: ...; name : ...; schema ?: ...; strict ?: ...; } ; type : "json_schema" ; } | null ; template : | { messages : (...)[] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: (...) | (...) | (...); tool_choice ?: (...) | (...) | (...) | (...) | (...); tools : (...)[] ; type : "tools" ; } | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_identifier : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: ...; max_tokens : ...; output_config ?: ...; stop_sequences ?: ...; temperature ?: ...; thinking ?: ...; top_p ?: ...; } ; type : "anthropic" ; } | { aws : { max_tokens ?: ...; stop_sequences ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "aws" ; } | { azure_openai : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "cerebras" ; } | { deepseek : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "deepseek" ; } | { fireworks : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "fireworks" ; } | { google : { frequency_penalty ?: ...; max_output_tokens ?: ...; presence_penalty ?: ...; stop_sequences ?: ...; temperature ?: ...; thinking_config ?: ...; top_k ?: ...; top_p ?: ...; } ; type : "google" ; } | { groq : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "groq" ; } | { moonshot : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "moonshot" ; } | { ollama : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "ollama" ; } | { openai : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "openai" ; } | { perplexity : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "perplexity" ; } | { together : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: ...; name : ...; schema ?: ...; strict ?: ...; } ; type : "json_schema" ; } | null ; template : | { messages : (...)[] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: (...) | (...) | (...); tool_choice ?: (...) | (...) | (...) | (...) | (...); tools : (...)[] ; type : "tools" ; } | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { prompt_identifier : string } ; query ?: { cursor ?: string | null ; limit ?: number } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { prompt_identifier : string }
prompt_identifier : string
Optionalquery ?: { cursor ?: string | null ; limit ?: number }
Optionalcursor ?: string | null
Optionallimit ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: ...; max_tokens : ...; output_config ?: ...; stop_sequences ?: ...; temperature ?: ...; thinking ?: ...; top_p ?: ...; } ; type : "anthropic" ; } | { aws : { max_tokens ?: ...; stop_sequences ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "aws" ; } | { azure_openai : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "cerebras" ; } | { deepseek : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "deepseek" ; } | { fireworks : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "fireworks" ; } | { google : { frequency_penalty ?: ...; max_output_tokens ?: ...; presence_penalty ?: ...; stop_sequences ?: ...; temperature ?: ...; thinking_config ?: ...; top_k ?: ...; top_p ?: ...; } ; type : "google" ; } | { groq : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "groq" ; } | { moonshot : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "moonshot" ; } | { ollama : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "ollama" ; } | { openai : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "openai" ; } | { perplexity : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "perplexity" ; } | { together : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: ...; name : ...; schema ?: ...; strict ?: ...; } ; type : "json_schema" ; } | null ; template : | { messages : (...)[] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: (...) | (...) | (...); tool_choice ?: (...) | (...) | (...) | (...) | (...); tools : (...)[] ; type : "tools" ; } | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { description ?: string | null ; id : string ; invocation_parameters : | { anthropic : { extra_body ?: ...; max_tokens : ...; output_config ?: ...; stop_sequences ?: ...; temperature ?: ...; thinking ?: ...; top_p ?: ...; } ; type : "anthropic" ; } | { aws : { max_tokens ?: ...; stop_sequences ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "aws" ; } | { azure_openai : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "azure_openai" ; } | { cerebras : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "cerebras" ; } | { deepseek : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "deepseek" ; } | { fireworks : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "fireworks" ; } | { google : { frequency_penalty ?: ...; max_output_tokens ?: ...; presence_penalty ?: ...; stop_sequences ?: ...; temperature ?: ...; thinking_config ?: ...; top_k ?: ...; top_p ?: ...; } ; type : "google" ; } | { groq : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "groq" ; } | { moonshot : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "moonshot" ; } | { ollama : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "ollama" ; } | { openai : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "openai" ; } | { perplexity : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "perplexity" ; } | { together : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; type : "together" ; } | { type : "xai" ; xai : { extra_body ?: ...; frequency_penalty ?: ...; max_completion_tokens ?: ...; max_tokens ?: ...; presence_penalty ?: ...; reasoning_effort ?: ...; seed ?: ...; stop ?: ...; temperature ?: ...; top_p ?: ...; } ; } ; model_name : string ; model_provider : | "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER" ; response_format ?: | { json_schema : { description ?: ...; name : ...; schema ?: ...; strict ?: ...; } ; type : "json_schema" ; } | null ; template : | { messages : (...)[] ; type : "chat" } | { template : string ; type : "string" } ; template_format : "NONE" | "MUSTACHE" | "F_STRING" ; template_type : "STR" | "CHAT" ; tools ?: | { disable_parallel_tool_calls ?: (...) | (...) | (...); tool_choice ?: (...) | (...) | (...) | (...) | (...); tools : (...)[] ; type : "tools" ; } | null ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/secrets
"/v1/secrets" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { secrets : { key : string ; value : string | null } [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { deleted_keys : string [] ; upserted_keys : string [] } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "507" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
put : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { secrets : { key : string ; value : string | null } [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { deleted_keys : string [] ; upserted_keys : string [] } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "507" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : { secrets : { key : string ; value : string | null } [] ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : { deleted_keys : string [] ; upserted_keys : string [] } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "507" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { deleted_keys : string [] ; upserted_keys : string [] } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
507 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionaltrace ?: undefined
/v1/session_ annotations
"/v1/session_annotations" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { sync ?: boolean } ; } ; requestBody : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: string | null ; label ?: string | null ; score ?: number | null ; } | null ; session_id : string ; } [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { sync ?: boolean } ; } ; requestBody : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: string | null ; label ?: string | null ; score ?: number | null ; } | null ; session_id : string ; } [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { sync ?: boolean } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { sync ?: boolean }
requestBody : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: string | null ; label ?: string | null ; score ?: number | null ; } | null ; session_id : string ; } [] ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/session_ notes
"/v1/session_notes" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { data : { identifier ?: string ; note : string ; session_id : string } ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { data : { identifier ?: string ; note : string ; session_id : string } ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : { data : { identifier ?: string ; note : string ; session_id : string } ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/sessions/{session_ identifier}
"/v1/sessions/{session_identifier}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { session_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { session_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { end_time : string ; id : string ; project_id : string ; session_id : string ; start_time : string ; token_count_completion ?: number ; token_count_prompt ?: number ; token_count_total ?: number ; traces : { end_time : string ; id : string ; start_time : string ; trace_id : string ; } [] ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { session_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { session_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { session_identifier : string }
session_identifier : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { session_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { end_time : string ; id : string ; project_id : string ; session_id : string ; start_time : string ; token_count_completion ?: number ; token_count_prompt ?: number ; token_count_total ?: number ; traces : { end_time : string ; id : string ; start_time : string ; trace_id : string ; } [] ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { session_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { session_identifier : string }
session_identifier : string
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { end_time : string ; id : string ; project_id : string ; session_id : string ; start_time : string ; token_count_completion ?: number ; token_count_prompt ?: number ; token_count_total ?: number ; traces : { end_time : string ; id : string ; start_time : string ; trace_id : string ; } [] ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { end_time : string ; id : string ; project_id : string ; session_id : string ; start_time : string ; token_count_completion ?: number ; token_count_prompt ?: number ; token_count_total ?: number ; traces : { end_time : string ; id : string ; start_time : string ; trace_id : string ; } [] ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/sessions/delete
"/v1/sessions/delete" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { session_identifiers : string [] } } ; } ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { session_identifiers : string [] } } ; } ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : { session_identifiers : string [] } } }
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/span_ annotations
"/v1/span_annotations" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { sync ?: boolean } ; } ; requestBody : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: string | null ; label ?: string | null ; score ?: number | null ; } | null ; span_id : string ; } [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { sync ?: boolean } ; } ; requestBody : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: string | null ; label ?: string | null ; score ?: number | null ; } | null ; span_id : string ; } [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { sync ?: boolean } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { sync ?: boolean }
requestBody : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: string | null ; label ?: string | null ; score ?: number | null ; } | null ; span_id : string ; } [] ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/span_ notes
"/v1/span_notes" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { data : { identifier ?: string ; note : string ; span_id : string } ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { data : { identifier ?: string ; note : string ; span_id : string } ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : { data : { identifier ?: string ; note : string ; span_id : string } ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/spans/{span_ identifier}
"/v1/spans/{span_identifier}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { span_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { span_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { span_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { span_identifier : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/system/api_ keys
"/v1/system/api_keys" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { data : { description ?: string | null ; expires_at ?: string | null ; name : string ; } ; } ; } ; } ; responses : { "201" : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; key : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "507" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
401 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { data : { description ?: string | null ; expires_at ?: string | null ; name : string ; } ; } ; } ; } ; responses : { "201" : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; key : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "507" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : { data : { description ?: string | null ; expires_at ?: string | null ; name : string ; } ; } ; } ; }
responses : { "201" : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; key : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "507" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
201 : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; key : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
401 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
507 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/system/api_ keys/{api_ key_ id}
"/v1/system/api_keys/{api_key_id}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { api_key_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { api_key_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { api_key_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { api_key_id : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
401 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/trace_ annotations
"/v1/trace_annotations" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { sync ?: boolean } ; } ; requestBody : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: string | null ; label ?: string | null ; score ?: number | null ; } | null ; trace_id : string ; } [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { sync ?: boolean } ; } ; requestBody : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: string | null ; label ?: string | null ; score ?: number | null ; } | null ; trace_id : string ; } [] ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { sync ?: boolean } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { sync ?: boolean }
requestBody : { content : { "application/json" : { data : { annotator_kind : "LLM" | "CODE" | "HUMAN" ; identifier ?: string ; metadata ?: { [ key : string ]: unknown } | null ; name : string ; result ?: | { explanation ?: string | null ; label ?: string | null ; score ?: number | null ; } | null ; trace_id : string ; } [] ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { id : string } [] } } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/trace_ notes
"/v1/trace_notes" : { delete ?: undefined ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { data : { identifier ?: string ; note : string ; trace_id : string } ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { data : { identifier ?: string ; note : string ; trace_id : string } ; } ; } ; } ; responses : { "200" : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : { data : { identifier ?: string ; note : string ; trace_id : string } ; } ; } ; }
responses : { "200" : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { id : string } } } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/traces/{trace_ identifier}
"/v1/traces/{trace_identifier}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { trace_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { trace_identifier : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { trace_identifier : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { trace_identifier : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "application/json" : { detail ?: { ctx ?: Record < (...), (...)> ; input ?: unknown ; loc : ((...) | (...))[] ; msg : string ; type : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/user
"/v1/user" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : | { auth_method : "ANONYMOUS" } | { auth_method : "LOCAL" ; created_at : string ; email : string ; id : string ; password ?: string ; password_needs_reset : boolean ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "OAUTH2" ; created_at : string ; email : string ; id : string ; oauth2_client_id ?: string ; oauth2_user_id ?: string ; profile_picture_url ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "LDAP" ; created_at : string ; email : string ; id : string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : | { auth_method : "ANONYMOUS" } | { auth_method : "LOCAL" ; created_at : string ; email : string ; id : string ; password ?: string ; password_needs_reset : boolean ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "OAUTH2" ; created_at : string ; email : string ; id : string ; oauth2_client_id ?: string ; oauth2_user_id ?: string ; profile_picture_url ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "LDAP" ; created_at : string ; email : string ; id : string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : | { auth_method : "ANONYMOUS" } | { auth_method : "LOCAL" ; created_at : string ; email : string ; id : string ; password ?: string ; password_needs_reset : boolean ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "OAUTH2" ; created_at : string ; email : string ; id : string ; oauth2_client_id ?: string ; oauth2_user_id ?: string ; profile_picture_url ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "LDAP" ; created_at : string ; email : string ; id : string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : | { auth_method : "ANONYMOUS" } | { auth_method : "LOCAL" ; created_at : string ; email : string ; id : string ; password ?: string ; password_needs_reset : boolean ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "OAUTH2" ; created_at : string ; email : string ; id : string ; oauth2_client_id ?: string ; oauth2_user_id ?: string ; profile_picture_url ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "LDAP" ; created_at : string ; email : string ; id : string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
401 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/user/api_ keys
"/v1/user/api_keys" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { data : { description ?: string | null ; expires_at ?: string | null ; name : string ; } ; } ; } ; } ; responses : { "201" : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; key : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "507" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; name : string ; } [] ; } ; } ; headers : { [ name : string ]: unknown } ; }
401 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { data : { description ?: string | null ; expires_at ?: string | null ; name : string ; } ; } ; } ; } ; responses : { "201" : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; key : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "507" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : { data : { description ?: string | null ; expires_at ?: string | null ; name : string ; } ; } ; } ; }
responses : { "201" : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; key : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "507" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
201 : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; key : string ; name : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
401 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
507 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/user/api_ keys/{api_ key_ id}
"/v1/user/api_keys/{api_key_id}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { api_key_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { api_key_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { api_key_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { api_key_id : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
401 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/users
"/v1/users" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : ( | { auth_method : "LOCAL" ; created_at : string ; email : string ; id : string ; password ?: string ; password_needs_reset : boolean ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "OAUTH2" ; created_at : string ; email : string ; id : string ; oauth2_client_id ?: string ; oauth2_user_id ?: string ; profile_picture_url ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "LDAP" ; created_at : string ; email : string ; id : string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { send_welcome_email ?: boolean ; user : | { auth_method : "LOCAL" ; email : string ; password ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; username : string ; } | { auth_method : "OAUTH2" ; email : string ; oauth2_client_id ?: string ; oauth2_user_id ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; username : string ; } | { auth_method : "LDAP" ; email : string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; username : string ; } ; } ; } ; } ; responses : { "201" : { content : { "application/json" : { data : | { auth_method : "LOCAL" ; created_at : string ; email : string ; id : string ; password ?: string ; password_needs_reset : boolean ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "OAUTH2" ; created_at : string ; email : string ; id : string ; oauth2_client_id ?: string ; oauth2_user_id ?: string ; profile_picture_url ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "LDAP" ; created_at : string ; email : string ; id : string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "409" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : ( | { auth_method : "LOCAL" ; created_at : string ; email : string ; id : string ; password ?: string ; password_needs_reset : boolean ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "OAUTH2" ; created_at : string ; email : string ; id : string ; oauth2_client_id ?: string ; oauth2_user_id ?: string ; profile_picture_url ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "LDAP" ; created_at : string ; email : string ; id : string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string ; limit ?: number } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { cursor ?: string ; limit ?: number }
Optionalcursor ?: string
Optionallimit ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : ( | { auth_method : "LOCAL" ; created_at : string ; email : string ; id : string ; password ?: string ; password_needs_reset : boolean ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "OAUTH2" ; created_at : string ; email : string ; id : string ; oauth2_client_id ?: string ; oauth2_user_id ?: string ; profile_picture_url ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "LDAP" ; created_at : string ; email : string ; id : string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : ( | { auth_method : "LOCAL" ; created_at : string ; email : string ; id : string ; password ?: string ; password_needs_reset : boolean ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "OAUTH2" ; created_at : string ; email : string ; id : string ; oauth2_client_id ?: string ; oauth2_user_id ?: string ; profile_picture_url ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "LDAP" ; created_at : string ; email : string ; id : string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } )[] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
post : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; requestBody : { content : { "application/json" : { send_welcome_email ?: boolean ; user : | { auth_method : "LOCAL" ; email : string ; password ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; username : string ; } | { auth_method : "OAUTH2" ; email : string ; oauth2_client_id ?: string ; oauth2_user_id ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; username : string ; } | { auth_method : "LDAP" ; email : string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; username : string ; } ; } ; } ; } ; responses : { "201" : { content : { "application/json" : { data : | { auth_method : "LOCAL" ; created_at : string ; email : string ; id : string ; password ?: string ; password_needs_reset : boolean ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "OAUTH2" ; created_at : string ; email : string ; id : string ; oauth2_client_id ?: string ; oauth2_user_id ?: string ; profile_picture_url ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "LDAP" ; created_at : string ; email : string ; id : string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "409" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
requestBody : { content : { "application/json" : { send_welcome_email ?: boolean ; user : | { auth_method : "LOCAL" ; email : string ; password ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; username : string ; } | { auth_method : "OAUTH2" ; email : string ; oauth2_client_id ?: string ; oauth2_user_id ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; username : string ; } | { auth_method : "LDAP" ; email : string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; username : string ; } ; } ; } ; }
responses : { "201" : { content : { "application/json" : { data : | { auth_method : "LOCAL" ; created_at : string ; email : string ; id : string ; password ?: string ; password_needs_reset : boolean ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "OAUTH2" ; created_at : string ; email : string ; id : string ; oauth2_client_id ?: string ; oauth2_user_id ?: string ; profile_picture_url ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "LDAP" ; created_at : string ; email : string ; id : string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "400" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "409" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
201 : { content : { "application/json" : { data : | { auth_method : "LOCAL" ; created_at : string ; email : string ; id : string ; password ?: string ; password_needs_reset : boolean ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "OAUTH2" ; created_at : string ; email : string ; id : string ; oauth2_client_id ?: string ; oauth2_user_id ?: string ; profile_picture_url ?: string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } | { auth_method : "LDAP" ; created_at : string ; email : string ; id : string ; role : "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER" ; updated_at : string ; username : string ; } ; } ; } ; headers : { [ name : string ]: unknown } ; }
400 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
409 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/users/{user_ id}
"/v1/users/{user_id}" : { delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { user_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; get ?: undefined ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
delete : { parameters : { cookie ?: undefined ; header ?: undefined ; path : { user_id : string } ; query ?: undefined ; } ; requestBody ?: undefined ; responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path : { user_id : string } ; query ?: undefined ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
path : { user_id : string }
Optionalquery ?: undefined
OptionalrequestBody ?: undefined
responses : { "204" : { content ?: undefined ; headers : { [ name : string ]: unknown } } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "404" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
204 : { content ?: undefined ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
404 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalget ?: undefined
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
/v1/users/api_ keys
"/v1/users/api_keys" : { delete ?: undefined ; get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; name : string ; user : { email : string | null ; id : string ; username : string } ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; } ; head ?: undefined ; options ?: undefined ; parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined ; } ; patch ?: undefined ; post ?: undefined ; put ?: undefined ; trace ?: undefined ; }
Type Declaration
Optionaldelete ?: undefined
get : { parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; limit ?: number } ; } ; requestBody ?: undefined ; responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; name : string ; user : { email : string | null ; id : string ; username : string } ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; } ; }
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: { cursor ?: string | null ; limit ?: number } ; }
Optionalcookie ?: undefined
Optionalheader ?: undefined
Optionalpath ?: undefined
Optionalquery ?: { cursor ?: string | null ; limit ?: number }
Optionalcursor ?: string | null
Optionallimit ?: number
OptionalrequestBody ?: undefined
responses : { "200" : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; name : string ; user : { email : string | null ; id : string ; username : string } ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; } ; "401" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "403" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; "422" : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } ; } ; }
200 : { content : { "application/json" : { data : { created_at : string ; description ?: string | null ; expires_at ?: string | null ; id : string ; name : string ; user : { email : string | null ; id : string ; username : string } ; } [] ; next_cursor : string | null ; } ; } ; headers : { [ name : string ]: unknown } ; }
401 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
403 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
422 : { content : { "text/plain" : string } ; headers : { [ name : string ]: unknown } }
Optionalhead ?: undefined
Optionaloptions ?: undefined
parameters : { cookie ?: undefined ; header ?: undefined ; path ?: undefined ; query ?: undefined }
Optionalpatch ?: undefined
Optionalpost ?: undefined
Optionalput ?: undefined
Optionaltrace ?: undefined
This file was auto-generated by openapi-typescript. Do not make direct changes to the file.