> ## 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. # Ask Effective to catalogue a product > Ask Effective to record a product's states, filings, manuals, forms and documents. Use it for a product not yet catalogued (`availabilitySummary.stateCount` 0: Effective knows the product exists and nothing more) or one with gaps. Make the request only when the user wants it; it notifies Effective staff. Effective resolves the request as `catalogued` when the product has recorded states, or `declined` with a reason; the requester is told by inbox and email, and getProductCatalogRequest shows the status. Safe to retry: while your organization has an open request for the product, the call returns it unchanged with `created: false` (the note is not updated). After it is resolved, a new call opens a new request. Returns 201 when a request was created, otherwise 200. Requires a writable user credential. Access: open to any caller with products:view. ## OpenAPI ````yaml /openapi.json post /insurance/products/{productId}/catalog-requests 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/products/{productId}/catalog-requests: post: tags: - Products summary: Ask Effective to catalogue a product description: >- Ask Effective to record a product's states, filings, manuals, forms and documents. Use it for a product not yet catalogued (`availabilitySummary.stateCount` 0: Effective knows the product exists and nothing more) or one with gaps. Make the request only when the user wants it; it notifies Effective staff. Effective resolves the request as `catalogued` when the product has recorded states, or `declined` with a reason; the requester is told by inbox and email, and getProductCatalogRequest shows the status. Safe to retry: while your organization has an open request for the product, the call returns it unchanged with `created: false` (the note is not updated). After it is resolved, a new call opens a new request. Returns 201 when a request was created, otherwise 200. Requires a writable user credential. Access: open to any caller with products:view. operationId: createProductCatalogRequest parameters: - schema: type: string description: >- Managed product_ ID or bare checked code; case-insensitive with Crockford aliases. required: true description: >- Managed product_ ID or bare checked code; case-insensitive with Crockford aliases. name: productId in: path requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/V2ProductCatalogRequestCreate' responses: '200': description: Your organization already had an open request. content: application/json: schema: $ref: '#/components/schemas/V2ProductCatalogRequestCreated' '201': description: The request was created. content: application/json: schema: $ref: '#/components/schemas/V2ProductCatalogRequestCreated' '400': description: >- invalid_id for malformed, wrong-type or bad-checksum IDs; otherwise invalid_request. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '401': description: Missing or invalid credentials, or credential scope denied. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '403': description: The credential does not permit this operation. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '404': description: Product not found. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '415': description: Content-Type must be application/json. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '429': description: Rate limited. Honor Retry-After (seconds) when provided. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '500': description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '503': description: Dependency unavailable. Honor Retry-After (seconds). content: application/json: schema: $ref: '#/components/schemas/V2CodedError' security: - bearerAuth: [] components: schemas: V2ProductCatalogRequestCreate: type: object properties: note: type: string minLength: 1 maxLength: 2000 description: >- What you need from the product (states, filings, forms), for Effective staff; up to 2,000 characters. additionalProperties: false V2ProductCatalogRequestCreated: type: object properties: productId: type: string description: Canonical `product_` ID. created: type: boolean description: False when your organization already had an open request. request: $ref: '#/components/schemas/V2ProductCatalogRequest' required: - productId - created - request 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: Not currently returned. required: - code V2ProductCatalogRequest: type: object nullable: true properties: id: type: string format: uuid productId: type: string description: Canonical `product_` ID. status: type: string enum: - open - catalogued - declined description: >- `open` until Effective resolves it; `catalogued` once the product has recorded states, filings and documents (read the product again); `declined` when Effective will not catalogue it now (see `resolutionNote`). note: type: string nullable: true description: The requester's note, if any. resolutionNote: type: string nullable: true description: >- Why the request was declined, or what was catalogued. Null while open. createdAt: type: string format: date-time resolvedAt: type: string nullable: true format: date-time required: - id - productId - status - note - resolutionNote - createdAt - resolvedAt additionalProperties: false description: >- Your organization's open request, otherwise its most recent resolved one; null if it never asked. 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.