> ## Documentation Index > Fetch the complete documentation index at: https://docs.canary.effectiveai.app/llms.txt > Use this file to discover all available pages before exploring further. # Rate a submission with a rater’s latest release > Rate one submission with your rater’s latest release. The request and response match [Rate a submission with a rater release](/api-reference/your-raters/rate-a-submission-with-a-rater-release). A new release changes what this operation rates. The response’s `releaseVersion` and `bundleId` name what rated. Rating changes nothing, so the request is safe to repeat. ## OpenAPI ````yaml /openapi.json post /insurance/raters/{id}/rate openapi: 3.0.3 info: title: Effective API version: 2.0.0 description: The public Effective REST API. Authenticate using an Effective API key. servers: - url: https://api.canary.effectiveai.app/api/v2 description: Canary security: - bearerAuth: [] paths: /insurance/raters/{id}/rate: post: tags: - Your raters summary: Rate a submission with a rater’s latest release description: >- Rate one submission with your rater’s latest release. The request and response match [Rate a submission with a rater release](/api-reference/your-raters/rate-a-submission-with-a-rater-release). A new release changes what this operation rates. The response’s `releaseVersion` and `bundleId` name what rated. Rating changes nothing, so the request is safe to repeat. operationId: rateRater parameters: - schema: type: string minLength: 1 maxLength: 128 pattern: ^[a-z0-9][a-z0-9._-]{0,127}$ description: >- Your organization’s rater ID, as given when the rater was first deployed. required: true description: >- Your organization’s rater ID, as given when the rater was first deployed. name: id in: path requestBody: required: true content: application/json: schema: type: object properties: inputs: type: object additionalProperties: nullable: true description: >- Engine input: one key per root record, for example `{"Policy": {...}}`. detailed: type: boolean description: >- When true, return computed calculation values as well as declared outcomes. Omit or set false to return only the release contract’s outputSchema. Values and table cells not needed by the outcomes may be absent. required: - inputs additionalProperties: false responses: '200': description: Native rating result, timings and exact bundle identity. content: application/json: schema: $ref: '#/components/schemas/V2RaterRateResult' '400': description: Invalid request or cursor. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '403': description: The user permission is missing. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '404': description: rater_not_found or release_not_found. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '409': description: >- contract_unavailable: the release has no stored contract. Upload and release a new build of the rater. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '413': description: The inputs exceed 1 MiB. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '415': description: The request body is not application/json. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '422': description: invalid_inputs, business_rejection or evaluation_failed. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '429': description: Too many requests, or rater_overloaded. Retry after Retry-After. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '500': description: Unexpected failure. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '503': description: >- rate_timeout, rater_unavailable or a dependency is unavailable. Retry after Retry-After. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' security: - bearerAuth: [] components: schemas: V2RaterRateResult: type: object properties: executionId: type: string description: >- ID of the recorded rating. Failed ratings return it too. Keep it to correlate a quote with support. raterId: type: string minLength: 1 maxLength: 128 pattern: ^[a-z0-9][a-z0-9._-]{0,127}$ description: >- Your organization’s rater ID, as given when the rater was first deployed. releaseVersion: type: integer minimum: 0 exclusiveMinimum: true description: The release that rated the submission. bundleId: type: string pattern: ^[a-f0-9]{64}$ description: SHA-256 identity of the engine bundle that rated the submission. programFingerprint: type: string description: Fingerprint of the compiled rating program. result: type: object additionalProperties: nullable: true description: >- Outputs keyed by root record. Omitted or false detailed returns the release contract’s outputSchema. With detailed true, result also contains computed calculation values; values and table cells not needed by the outcomes may be absent. timings: type: object properties: totalMs: type: number minimum: 0 coldStartMs: type: number minimum: 0 evaluateMs: type: number minimum: 0 workerMs: type: number minimum: 0 materializeMs: type: number minimum: 0 required: - totalMs - workerMs additionalProperties: false description: >- Milliseconds spent on this rating. coldStartMs is present only on a cold start. required: - executionId - raterId - releaseVersion - bundleId - programFingerprint - result - timings additionalProperties: false V2CodedError: allOf: - $ref: '#/components/schemas/V2Error' - type: object properties: code: type: string minLength: 1 description: Stable error code. Clients must tolerate unknown future codes. details: type: array items: type: object properties: location: type: string enum: - path - query - header - body path: type: array items: type: string maxLength: 64 maxItems: 12 code: type: string enum: - required - invalid_type - invalid_value - unknown_field message: type: string minLength: 1 maxLength: 200 required: - location - path - code - message minItems: 1 maxItems: 20 description: Bounded safe validation issues; may omit some invalid fields. requestId: type: string minLength: 1 maxLength: 128 description: >- Existing server correlation for this HTTP attempt, when available. dataset: type: string enum: - naic - osha description: Dataset needed for dataset_not_enabled. businessCode: type: string description: The rater’s own refusal code, for business_rejection. violations: type: array items: type: object properties: code: type: string description: Authored or built-in constraint code message: type: string description: Authored message for the failed constraint path: type: string description: Input path of the offending value; empty for the request value: nullable: true description: Offending input value, size-bounded by the runtime constraint: type: string description: The constraint the value failed, as text cite: type: string nullable: true description: >- Filing citation of the constraint, when the source cites one required: - code - message - path - value - constraint - cite additionalProperties: false maxItems: 256 description: >- Each input constraint the submission failed, for invalid_inputs and business_rejection. violationsTruncated: type: boolean description: >- True when the rater reported more violations than violations holds. executionId: type: string description: >- The recorded execution of a failed rating, for rater rating failures. accessUrl: type: string nullable: true format: uri description: >- Where to add the product to your account, for product_access_required. required: - code V2Error: type: object properties: error: type: string minLength: 1 description: Human-readable explanation of the failure. required: - error securitySchemes: bearerAuth: type: http scheme: bearer description: 'Effective API key. Send Authorization: Bearer sk-eai-...' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.