> ## Documentation Index > Fetch the complete documentation index at: https://docs.orq.ai/llms.txt > Use this file to discover all available pages before exploring further. # Classify > **Beta.** Runs typed classification questions (`noul`, `choice`, `score`) against a classify model such as `typesafe/jev-latest`. The request and response proxy the TypeSafe classification contract 1:1; `model` in the response is the orq model id that served the request and `usage` carries the computed cost like the Responses API. This endpoint currently does not apply PII plugins or guardrails. **Related guide**: Classify guide. See the [Classify guide](/docs/ai-gateway/features/classify) for a walkthrough with examples. ## OpenAPI ````yaml post /v3/router/classify openapi: 3.1.0 info: title: orq.ai API version: '2.0' description: orq.ai API documentation servers: - url: https://my.orq.ai security: - ApiKey: [] tags: - name: Chunking description: Split text into smaller chunks for retrieval and generation workflows. - name: File Systems description: >- Create and manage persistent file systems that agents and MCP clients read from and write to. - name: Knowledge Bases description: Create and manage knowledge bases used by agents and retrieval workflows. - name: Memory Stores description: Create and manage memory stores, memories, and memory documents. - name: Evals description: Run an evaluator against a conversation and its result - name: Logs description: >- OpenTelemetry log query API. Search, filter, aggregate, and facet log records ingested via OTLP. - name: Reporting description: >- GenAI reporting API over canonical analytics rollups. Accepts a metric name, time range, grain, group-by, and filters; returns a typed time series and optional totals. - name: Traces description: >- Query and inspect ingested trace data: search trace summaries, aggregate metrics, and read individual traces and their spans. - description: List models available through the AI Router. name: Models - name: Policies - name: Alerts description: >- Alerts evaluate a Reporting API metric on a fixed interval and fire notifications through notifiers when the value breaches a threshold. Each breach opens a trigger that tracks the incident until the value recovers. - name: Annotation Queues description: Annotation queues collect spans for human review. - name: API keys description: >- API keys authenticate programmatic access to the workspace. They expose opaque tokens, per-domain access grants, and budget and rate-limit constraints. - name: Audit Logs description: Audit logs record workspace entity changes and access-relevant events. - name: Budgets description: >- Budgets govern spend, token usage, and request rate across six scopes: workspace, project, identity, API key, provider, and model. Every applicable budget is enforced, and the most restrictive limit applies per dimension. - name: Files description: File upload and retrieval operations. - name: Guardrail Rules description: >- Guardrail Rules conditionally enforce evaluators and plugins for AI Gateway traffic. Rules may be scoped to a project or the whole workspace. - name: Hub description: Hub items are reusable templates available to a workspace. - name: Identities description: >- Identities represent end users from your system for usage and engagement tracking. - name: Management keys description: >- Management keys are workspace-scoped credentials that authenticate programmatic access to workspace administration surfaces (API keys, budgets). Unlike project-scoped API keys, a management key always operates at the workspace level. - name: MCP Gateway description: >- Register upstream MCP servers, discover and sync their tools, and assemble gateways that expose a curated tool surface to MCP clients. - name: Model Catalog description: >- Browse the orq.ai model catalog: every model orq offers, across every provider, with pricing, capabilities and benchmark data. List endpoints only return models that are not deprecated. This API is public, requires no authentication, and is rate limited to 120 requests per minute per IP. Responses carry a 5-minute cache-control max-age. - name: Notifiers description: Notifier destinations used to send delivery and workflow notifications. - name: Projects description: Projects organize resources within a workspace - name: Routing Rules description: >- Routing Rules conditionally select models and enforce request plugins for AI Gateway traffic. Rules are evaluated by ascending priority and may be scoped to a project or the whole workspace. - name: Threads description: Threads group related trace invocations and their aggregate usage - name: Skills description: >- Skills are modular instructions you can use to codify processes and conventions - name: Smart Routers description: >- Create and manage workspace Smart Routers. A Smart Router selects a model from an eligible pool for each request according to a quality, balanced, or cost profile. - name: Webhooks description: >- Create and manage webhooks that deliver workspace events to external HTTPS endpoints. - name: Workspaces description: >- A workspace is the tenant. Create is a user-session onboarding RPC; Get, List, and Update are the public management surface. - name: Workspace Security description: >- Workspace-level domain verification and IP allowlist controls. These operations are restricted to workspace administrators. - name: Workspace Settings description: >- Workspace-level settings managed with a workspace credential. A workspace is the tenant, so these settings are a singleton — there is nothing to create or delete, only read and update. - name: Responses - description: Run agents on a cron cadence. Minimum firing interval is 1 hour. name: Agent Schedules - name: Embeddings - name: Telemetry description: >- Unified query envelope for traces, metrics, and logs (ADR 0004). One request shape, one filter dialect, and one response shape per source, validated by a per-source registry. - description: Beta. Run typed classification questions against a classify model. name: Classify externalDocs: url: https://docs.orq.ai description: orq.ai Documentation paths: /v3/router/classify: post: tags: - Classify summary: Classify description: >- **Beta.** Runs typed classification questions (`noul`, `choice`, `score`) against a classify model such as `typesafe/jev-latest`. The request and response proxy the TypeSafe classification contract 1:1; `model` in the response is the orq model id that served the request and `usage` carries the computed cost like the Responses API. This endpoint currently does not apply PII plugins or guardrails. operationId: CreateClassify requestBody: content: application/json: examples: support_ticket: summary: Classify a support message value: model: typesafe/jev-latest questions: is_complaint: instructions: Is the customer complaining? type: noul severity: criteria: - Minor - Moderate - Severe instructions: How severe is the issue? type: score topic: criteria: delivery: Shipping or delivery issues other: null product: Product quality instructions: What is the message mainly about? type: choice state: The parcel arrived two days late and the box was crushed. schema: additionalProperties: false properties: identity: $ref: '#/components/schemas/ResponseIdentity' description: The identity to attach to the trace. metadata: additionalProperties: type: string description: Key-value metadata attached to the trace. type: object model: description: >- ID of the classify model to use, for example typesafe/jev-latest. type: string name: description: >- The name to display on the trace. If not specified, the default system name will be used. type: string questions: additionalProperties: oneOf: - description: >- Answers with a probability between 0 and 1 that the statement holds. properties: criteria: description: Optional descriptions of what true and false mean. properties: 'false': type: string 'true': type: string type: object instructions: anyOf: - title: String type: string - additionalProperties: true title: Object type: object - items: {} title: Array type: array description: >- The evaluation prompt for this question. A string, an object or an array. type: enum: - noul type: string required: - type - instructions title: NoulQuestion type: object - description: >- Picks one of the given options and returns the probability of each. properties: criteria: additionalProperties: type: - string - 'null' description: >- Options keyed by name, each mapped to a description or null. minProperties: 1 type: object instructions: anyOf: - title: String type: string - additionalProperties: true title: Object type: object - items: {} title: Array type: array description: >- The evaluation prompt for this question. A string, an object or an array. type: enum: - choice type: string required: - type - instructions - criteria title: ChoiceQuestion type: object - description: >- Places the state on an ordered scale and returns the probability of each level. properties: criteria: description: >- Ordered level descriptions from lowest to highest. At least two levels. items: type: string minItems: 2 type: array instructions: anyOf: - title: String type: string - additionalProperties: true title: Object type: object - items: {} title: Array type: array description: >- The evaluation prompt for this question. A string, an object or an array. type: enum: - score type: string required: - type - instructions - criteria title: ScoreQuestion type: object description: >- Typed questions keyed by an identifier of your choice. Each answer is returned under the same key. minProperties: 1 type: object retry: $ref: '#/components/schemas/ClassifyRetryConfig' description: Retry configuration for the request. state: anyOf: - title: String type: string - additionalProperties: true title: Object type: object - items: {} title: Array type: array description: The content to evaluate. A string, an object or an array. required: - model - state - questions type: object required: true responses: '200': content: application/json: schema: additionalProperties: false properties: answers: additionalProperties: $ref: '#/components/schemas/ClassifyAnswer' description: >- Answers keyed by the question identifiers from the request. type: object model: description: >- The model that served the request, for example typesafe/jev-latest. type: string usage: $ref: '#/components/schemas/ClassifyUsage' description: The usage information for the request. required: - model - answers - usage type: object description: Returns one answer per question. '400': content: application/json: schema: additionalProperties: false properties: error: $ref: '#/components/schemas/APIError' required: - error type: object description: Malformed JSON or missing model. '422': content: application/json: schema: additionalProperties: false properties: error: $ref: '#/components/schemas/APIError' required: - error type: object description: The state or a question violates the classification contract. '429': content: application/json: schema: additionalProperties: false properties: error: $ref: '#/components/schemas/APIError' required: - error type: object description: Rate limited by the provider. x-code-samples: - label: Node.js lang: typescript source: |- const result = await orq.router.classify.create({ model: "typesafe/jev-latest", state: "The parcel arrived two days late and the box was crushed.", questions: { is_complaint: { type: "noul", instructions: "Is the customer complaining?" }, topic: { type: "choice", instructions: "What is the message mainly about?", criteria: { delivery: "Shipping or delivery issues", product: "Product quality", other: null }, }, severity: { type: "score", instructions: "How severe is the issue?", criteria: ["Minor", "Moderate", "Severe"] }, }, }); - label: Python lang: python source: |- result = client.router.classify.create( model="typesafe/jev-latest", state="The parcel arrived two days late and the box was crushed.", questions={ "is_complaint": {"type": "noul", "instructions": "Is the customer complaining?"}, "topic": { "type": "choice", "instructions": "What is the message mainly about?", "criteria": {"delivery": "Shipping or delivery issues", "product": "Product quality", "other": None}, }, "severity": {"type": "score", "instructions": "How severe is the issue?", "criteria": ["Minor", "Moderate", "Severe"]}, }, ) components: schemas: ResponseIdentity: additionalProperties: false properties: display_name: type: string email: type: string id: type: string metadata: items: type: object additionalProperties: {} type: - array - 'null' tags: items: type: string type: - array - 'null' required: - id type: object ClassifyRetryConfig: additionalProperties: false properties: count: description: Number of retry attempts (1-5). format: int64 type: integer on_codes: description: HTTP status codes that trigger retry logic. items: format: int64 type: integer type: - array - 'null' required: - count - on_codes type: object ClassifyAnswer: additionalProperties: false properties: choice: description: The selected option. Present for choice answers. type: string confidence: description: >- Confidence in the selected option or level. Present for choice and score answers. format: double type: number legend: additionalProperties: type: string description: Level index to level description. Present for score answers. type: object noul: description: >- Probability between 0 and 1 that the statement holds. Present for noul answers. format: double type: number probabilities: additionalProperties: type: number format: double description: >- Probability distribution over the options or levels. Present for choice and score answers. type: object score: description: The selected level index. Present for score answers. format: double type: number type: description: The question type this answer belongs to. enum: - noul - choice - score type: string required: - type type: object ClassifyUsage: additionalProperties: false properties: input_cost: description: >- Cost (USD) of input tokens. Present when billing was computed for this request. format: double type: number input_tokens: description: The number of input tokens processed. format: int64 type: integer output_cost: description: >- Cost (USD) of output tokens, always 0 for classify. Present when billing was computed for this request. format: double type: number output_tokens: description: The number of output tokens generated. Not billed. format: int64 type: integer total_cost: description: >- Total cost (USD) of the request. Present when billing was computed for this request. format: double type: number required: - input_tokens - output_tokens type: object APIError: additionalProperties: false properties: code: type: - string - 'null' failures: {} message: type: string param: type: - string - 'null' type: type: string required: - message - type - param - code type: object securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ````