{ "components": { "schemas": { "BusinessCreateResult": { "additionalProperties": false, "properties": { "application": { "additionalProperties": false, "properties": { "id": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" }, "object": { "const": "client_intake_application", "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "id", "object", "url" ], "type": "object" }, "business": { "additionalProperties": false, "properties": { "id": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "name": { "type": [ "string", "null" ] }, "object": { "const": "business", "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "id", "object", "name", "url" ], "type": "object" }, "file_uploads": { "items": { "additionalProperties": false, "properties": { "id": { "pattern": "^upl_.+$", "type": "string" }, "multiple": { "type": "boolean" }, "object": { "const": "file_upload", "type": "string" }, "request_path": { "type": "string" }, "upload_url": { "format": "uri", "type": "string" } }, "required": [ "id", "object", "request_path", "upload_url", "multiple" ], "type": "object" }, "type": "array" }, "invitation_url": { "format": "uri", "type": [ "string", "null" ] }, "warnings": { "items": { "type": "object" }, "type": "array" } }, "required": [ "business", "application", "invitation_url", "file_uploads", "warnings" ], "type": "object" }, "BusinessFileUploadResult": { "additionalProperties": false, "properties": { "application_file_bytes": { "type": "integer" }, "application_file_count": { "type": "integer" }, "filename": { "type": "string" }, "request_path": { "type": "string" }, "size": { "type": "integer" } }, "required": [ "request_path", "filename", "size", "application_file_count", "application_file_bytes" ], "type": "object" }, "BusinessPage": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "id": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "name": { "type": [ "string", "null" ] }, "object": { "const": "business", "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "id", "object", "name", "url" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "type": [ "string", "null" ] } }, "required": [ "object", "items", "next_cursor", "previous_cursor" ], "type": "object" }, "BusinessPeople": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "company_name": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "email": { "type": "string" }, "frontend_link": { "format": "uri", "type": [ "string", "null" ] }, "full_name": { "type": "string" }, "id": { "pattern": "^pers_[a-z0-9]+$", "type": "string" }, "is_do_not_contact": { "type": "boolean" }, "is_primary": { "type": "boolean" }, "job_title": { "type": "string" }, "notes": { "type": "string" }, "object": { "const": "person", "type": "string" }, "owner": { "anyOf": [ { "additionalProperties": false, "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "required": [ "email", "name" ], "type": "object" }, { "type": "null" } ] }, "phone_number": { "type": "string" }, "tags": { "items": { "additionalProperties": false, "properties": { "color": { "example": "#5B5BD6", "type": [ "string", "null" ] }, "id": { "pattern": "^ptag_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name", "color" ], "type": "object" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "full_name", "email", "phone_number", "company_name", "job_title", "is_do_not_contact", "notes", "owner", "tags", "created_at", "updated_at", "frontend_link", "is_primary" ], "type": "object" }, "type": "array" }, "object": { "const": "participant_list", "type": "string" }, "revision": { "minimum": 0, "type": "integer" } }, "required": [ "object", "items", "revision" ], "type": "object" }, "BusinessStageTransition": { "additionalProperties": false, "properties": { "id": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "object": { "const": "business", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "stage": { "additionalProperties": false, "properties": { "id": { "pattern": "^bstg_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "stage", "revision", "updated_at" ], "type": "object" }, "BusinessStatusResult": { "additionalProperties": false, "properties": { "application": { "oneOf": [ { "type": "null" }, { "additionalProperties": false, "properties": { "id": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" }, "object": { "const": "client_intake_application", "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "id", "object", "url" ], "type": "object" } ] }, "business": { "additionalProperties": false, "properties": { "id": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "is_sample": { "description": "A fictional onboarding example.", "type": "boolean" }, "name": { "type": [ "string", "null" ] }, "object": { "const": "business", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "status": { "additionalProperties": false, "properties": { "pipeline": { "type": "string" }, "stage": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "pipeline", "stage", "updated_at" ], "type": "object" }, "url": { "format": "uri", "type": "string" }, "workflow": { "additionalProperties": false, "properties": { "pipeline": { "additionalProperties": false, "properties": { "id": { "pattern": "^bpipe_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "stage": { "additionalProperties": false, "properties": { "id": { "pattern": "^bstg_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "stages_url": { "format": "uri", "type": "string" } }, "required": [ "pipeline", "stage", "stages_url" ], "type": "object" } }, "required": [ "id", "object", "name", "revision", "url", "status", "workflow" ], "type": "object" } }, "required": [ "business", "application" ], "type": "object" }, "ClientIntakeApplicationAnswerMutation": { "additionalProperties": false, "properties": { "affected_section_keys": { "items": { "type": "string" }, "type": "array" }, "answers_revision": { "minimum": 0, "type": "integer" }, "application": { "additionalProperties": false, "properties": { "id": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" }, "object": { "const": "client_intake_application", "type": "string" } }, "required": [ "id", "object" ], "type": "object" }, "object": { "const": "client_intake_application_answers", "type": "string" }, "updated_answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "maxLength": 64, "minLength": 1, "type": "string" }, "field_key": { "maxLength": 512, "minLength": 1, "type": "string" }, "schema_key": { "maxLength": 512, "minLength": 1, "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] } }, "required": [ "block_key", "schema_key", "field_key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "object", "application", "answers_revision", "updated_answers", "affected_section_keys" ], "type": "object" }, "ClientIntakeApplicationAnswerPage": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "items": { "items": { "additionalProperties": false, "properties": { "allowed_values": { "description": "Allowed choices for this answer, or an empty list when choices are not restricted.", "items": { "maxLength": 255, "type": "string" }, "type": "array" }, "block_key": { "description": "Stable question-block key. Send it unchanged when updating an answer.", "maxLength": 64, "minLength": 1, "type": "string" }, "block_label": { "description": "User-facing question or group name.", "type": "string" }, "field_key": { "description": "Stable field key. Send it unchanged with its block_key when updating the answer.", "maxLength": 512, "minLength": 1, "type": "string" }, "field_label": { "description": "User-facing field name.", "type": "string" }, "is_required": { "description": "Whether this answer is required when visible.", "type": "boolean" }, "schema_key": { "description": "Stable schema identity for interpreting this answer.", "maxLength": 512, "minLength": 1, "type": "string" }, "section_key": { "description": "Stable section key used to filter later reads.", "maxLength": 255, "minLength": 1, "type": "string" }, "section_label": { "description": "User-facing section name.", "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ], "description": "Current answer value, or null when unanswered." }, "value_type": { "description": "Expected kind of answer value.", "maxLength": 36, "minLength": 1, "type": "string" } }, "required": [ "section_key", "section_label", "block_key", "block_label", "schema_key", "field_key", "field_label", "value_type", "is_required", "allowed_values", "value" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "description": "Always null; this collection supports forward paging only.", "type": "null" } }, "required": [ "object", "items", "next_cursor", "previous_cursor", "answers_revision" ], "type": "object" }, "ClientIntakeApplicationContract": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "application_name": { "type": "string" }, "contract_version": { "type": "string" }, "description": { "type": "string" }, "instructions": { "type": "string" }, "object": { "const": "application_contract", "type": "string" }, "operations": { "additionalProperties": false, "properties": { "file_uploads_url": { "format": "uri", "type": "string" }, "files_url": { "format": "uri", "type": "string" }, "read_answers_url": { "format": "uri", "type": "string" }, "repeatable_items_url": { "format": "uri", "type": "string" }, "submit_url": { "format": "uri", "type": "string" }, "update_answers_url": { "format": "uri", "type": "string" } }, "required": [ "read_answers_url", "update_answers_url", "repeatable_items_url", "file_uploads_url", "files_url", "submit_url" ], "type": "object" }, "questions": { "items": { "additionalProperties": false, "properties": { "answer_operations": { "items": { "enum": [ "read", "update", "upload", "delete" ], "type": "string" }, "type": "array" }, "answer_shape": { "enum": [ "field", "selection_list", "file" ], "type": "string" }, "block_key": { "type": "string" }, "fields": { "items": { "additionalProperties": false, "properties": { "example": {}, "field_key": { "type": "string" }, "help_text": { "type": [ "string", "null" ] }, "is_required": { "type": "boolean" }, "label": { "type": "string" }, "value_schema": { "type": "object" } }, "required": [ "field_key", "label", "help_text", "is_required", "value_schema", "example" ], "type": "object" }, "type": "array" }, "help_text": { "type": [ "string", "null" ] }, "is_repeatable": { "type": "boolean" }, "is_required": { "type": "boolean" }, "kind": { "type": "string" }, "label": { "type": "string" }, "order": { "type": "integer" }, "parent_block_key": { "type": [ "string", "null" ] }, "schema_key": { "type": "string" }, "section_key": { "type": "string" }, "visibility": { "type": "object" } }, "required": [ "block_key", "schema_key", "section_key", "parent_block_key", "kind", "label", "help_text", "is_required", "is_repeatable", "answer_shape", "order", "answer_operations", "visibility", "fields" ], "type": "object" }, "type": "array" }, "repeatable_groups": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "item_operations": { "items": { "enum": [ "list", "create", "update", "delete" ], "type": "string" }, "type": "array" }, "item_question_keys": { "items": { "type": "string" }, "type": "array" }, "max_items": { "minimum": 0, "type": [ "integer", "null" ] }, "min_items": { "minimum": 0, "type": [ "integer", "null" ] }, "parent_block_key": { "type": [ "string", "null" ] }, "section_key": { "type": "string" } }, "required": [ "block_key", "section_key", "parent_block_key", "min_items", "max_items", "item_question_keys", "item_operations" ], "type": "object" }, "type": "array" }, "resource": { "additionalProperties": false, "properties": { "id": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" }, "object": { "const": "client_intake_application", "type": "string" } }, "required": [ "id", "object" ], "type": "object" }, "sections": { "items": { "additionalProperties": false, "properties": { "label": { "type": "string" }, "order": { "type": "integer" }, "section_key": { "type": "string" } }, "required": [ "section_key", "label", "order" ], "type": "object" }, "type": "array" } }, "required": [ "object", "contract_version", "answers_revision", "application_name", "description", "sections", "repeatable_groups", "questions", "resource", "operations", "instructions" ], "type": "object" }, "ClientIntakeApplicationResult": { "additionalProperties": false, "properties": { "application": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": [ "integer", "null" ] }, "answers_url": { "format": "uri", "type": "string" }, "autofill_preparation_url": { "format": "uri", "type": "string" }, "autofill_runs_url": { "format": "uri", "type": "string" }, "business": { "additionalProperties": false, "properties": { "id": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "name": { "type": [ "string", "null" ] }, "object": { "const": "business", "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "id", "object", "name", "url" ], "type": "object" }, "contract_url": { "format": "uri", "type": "string" }, "id": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" }, "object": { "const": "client_intake_application", "type": "string" }, "progress": { "oneOf": [ { "type": "null" }, { "additionalProperties": false, "properties": { "completed_items": { "minimum": 0, "type": "integer" }, "percent": { "maximum": 100, "minimum": 0, "type": "integer" }, "total_items": { "minimum": 0, "type": "integer" } }, "required": [ "completed_items", "total_items", "percent" ], "type": "object" } ] }, "revision": { "minimum": 0, "type": "integer" }, "status": { "oneOf": [ { "type": "null" }, { "additionalProperties": false, "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "updated_at": { "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "key", "label", "updated_at" ], "type": "object" } ] }, "submit_url": { "format": "uri", "type": "string" }, "submitted_at": { "format": "date-time", "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "id", "object", "revision", "answers_revision", "business", "status", "progress", "submitted_at", "updated_at", "url", "answers_url", "contract_url", "submit_url", "autofill_preparation_url", "autofill_runs_url" ], "type": "object" } }, "required": [ "application" ], "type": "object" }, "ClientIntakeAutofillPreparation": { "additionalProperties": false, "properties": { "ai_mode": { "enum": [ "fast", "thinking" ], "type": "string" }, "application": { "additionalProperties": false, "properties": { "id": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" }, "object": { "const": "client_intake_application", "type": "string" } }, "required": [ "id", "object" ], "type": "object" }, "can_start": { "type": "boolean" }, "evidence_sources": { "items": { "type": "object" }, "type": "array" }, "file_count": { "minimum": 0, "type": "integer" }, "files": { "description": "Supporting documents in preparation order, with their current processing status.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Document name shown in the Portal.", "example": "financial-statement.pdf", "type": [ "string", "null" ] }, "status": { "description": "Document processing: pending is queued; running is reading the file; success is ready for Autofill; failed needs attention.", "enum": [ "pending", "running", "success", "failed" ], "type": "string" } }, "required": [ "name", "status" ], "type": "object" }, "type": "array" }, "object": { "const": "client_intake_application_autofill_preparation", "type": "string" }, "revision": { "minimum": 1, "type": "integer" }, "selected_evidence_source_count": { "minimum": 0, "type": "integer" }, "start_url": { "format": "uri", "type": "string" }, "text_input": { "type": [ "string", "null" ] }, "uploaded_file": { "type": "object" } }, "required": [ "object", "application", "start_url", "revision", "text_input", "ai_mode", "file_count", "files", "selected_evidence_source_count", "evidence_sources", "can_start" ], "type": "object" }, "ClientIntakeAutofillPreparationUpdate": { "additionalProperties": false, "minProperties": 1, "properties": { "ai_mode": { "enum": [ "fast", "thinking" ], "type": "string" }, "text_input": { "type": "string" } }, "type": "object" }, "ClientIntakeAutofillRun": { "additionalProperties": false, "properties": { "application": { "additionalProperties": false, "properties": { "id": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" }, "object": { "const": "client_intake_application", "type": "string" } }, "required": [ "id", "object" ], "type": "object" }, "attempt_sequence": { "minimum": 1, "type": [ "integer", "null" ] }, "can_retry": { "type": "boolean" }, "created_at": { "format": "date-time", "type": "string" }, "failure": { "type": [ "object", "null" ] }, "id": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" }, "object": { "const": "client_intake_application_autofill_run", "type": "string" }, "progress": { "additionalProperties": false, "properties": { "completed_units": { "minimum": 0, "type": "integer" }, "step": { "type": "string" }, "total_units": { "minimum": 0, "type": "integer" } }, "required": [ "step", "completed_units", "total_units" ], "type": "object" }, "retry_url": { "format": "uri", "type": "string" }, "status": { "enum": [ "pending", "running", "completed", "failed" ], "type": "string" }, "suggestion_count": { "minimum": 0, "type": "integer" }, "suggestions_url": { "format": "uri", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "format": "uri", "type": "string" }, "warning_count": { "minimum": 0, "type": "integer" } }, "required": [ "id", "object", "application", "status", "progress", "suggestion_count", "warning_count", "can_retry", "attempt_sequence", "failure", "created_at", "updated_at", "url", "suggestions_url", "retry_url" ], "type": "object" }, "ClientIntakeAutofillStart": { "additionalProperties": false, "properties": { "ai_mode": { "enum": [ "fast", "thinking" ], "type": "string" }, "expected_preparation_revision": { "minimum": 1, "type": "integer" }, "selected_evidence_source_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "expected_preparation_revision" ], "type": "object" }, "ClientIntakeAutofillSuggestion": { "additionalProperties": false, "properties": { "concerns": { "items": { "type": "object" }, "type": "array" }, "created_at": { "format": "date-time", "type": "string" }, "current_value": {}, "display_order": { "type": "integer" }, "field_label": { "type": [ "string", "null" ] }, "id": { "pattern": "^afsug_[a-z0-9]+$", "type": "string" }, "object": { "const": "client_intake_application_autofill_suggestion", "type": "string" }, "proposed_value": {}, "question_label": { "type": [ "string", "null" ] }, "run": { "type": "object" }, "section_label": { "type": [ "string", "null" ] }, "source": { "type": "object" }, "status": { "enum": [ "pending", "accepted", "dismissed", "stale", "failed" ], "type": "string" }, "suggestion_kind": { "type": "string" }, "target_attribute": { "type": "string" }, "target_scope": { "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "run", "status", "section_label", "question_label", "field_label", "display_order", "suggestion_kind", "target_attribute", "target_scope", "current_value", "proposed_value", "source", "concerns", "created_at", "updated_at" ], "type": "object" }, "ClientIntakeAutofillSuggestionAcceptance": { "additionalProperties": false, "properties": { "answers_revision": { "description": "Use this revision for the next application-answer write.", "minimum": 0, "type": "integer" }, "suggestion": { "$ref": "#/components/schemas/ClientIntakeAutofillSuggestion" } }, "required": [ "suggestion", "answers_revision" ], "type": "object" }, "ClientIntakeAutofillSuggestionPage": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/ClientIntakeAutofillSuggestion" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "type": [ "string", "null" ] } }, "required": [ "object", "items", "next_cursor", "previous_cursor" ], "type": "object" }, "Deal": { "additionalProperties": false, "properties": { "application": { "type": "object" }, "created_at": { "format": "date-time", "type": "string" }, "id": { "pattern": "^deal_[a-z0-9]+$", "type": "string" }, "is_sample": { "description": "A fictional onboarding example.", "type": "boolean" }, "name": { "type": "string" }, "object": { "const": "deal", "type": "string" }, "project": { "type": [ "object", "null" ] }, "recipient": { "anyOf": [ { "$ref": "#/components/schemas/DealRecipientIdentity" }, { "type": "null" } ] }, "revision": { "minimum": 0, "type": "integer" }, "status": { "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "format": "uri", "type": "string" }, "workflow": { "additionalProperties": false, "properties": { "pipeline": { "additionalProperties": false, "properties": { "id": { "pattern": "^dpipe_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "stage": { "additionalProperties": false, "properties": { "id": { "pattern": "^dstg_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "stages_url": { "format": "uri", "type": "string" } }, "required": [ "pipeline", "stage", "stages_url" ], "type": "object" } }, "required": [ "id", "object", "revision", "application", "project", "recipient", "name", "status", "workflow", "created_at", "updated_at", "url" ], "type": "object" }, "DealApplication": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "answers_url": { "format": "uri", "type": "string" }, "contract_url": { "format": "uri", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "id": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "object": { "const": "deal_application", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "status": { "type": [ "string", "null" ] }, "submit_url": { "format": "uri", "type": "string" }, "submitted_at": { "format": "date-time", "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "id", "object", "revision", "answers_revision", "status", "submitted_at", "created_at", "updated_at", "url", "answers_url", "contract_url", "submit_url" ], "type": "object" }, "DealApplicationAnswerMutation": { "additionalProperties": false, "properties": { "affected_section_keys": { "items": { "type": "string" }, "type": "array" }, "answers_revision": { "minimum": 0, "type": "integer" }, "application": { "additionalProperties": false, "properties": { "id": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "object": { "const": "deal_application", "type": "string" } }, "required": [ "id", "object" ], "type": "object" }, "object": { "const": "deal_application_answers", "type": "string" }, "updated_answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "maxLength": 64, "minLength": 1, "type": "string" }, "field_key": { "maxLength": 512, "minLength": 1, "type": "string" }, "schema_key": { "maxLength": 512, "minLength": 1, "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] } }, "required": [ "block_key", "schema_key", "field_key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "object", "application", "answers_revision", "updated_answers", "affected_section_keys" ], "type": "object" }, "DealApplicationAnswerPage": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "items": { "items": { "additionalProperties": false, "properties": { "allowed_values": { "description": "Allowed choices for this answer, or an empty list when choices are not restricted.", "items": { "maxLength": 255, "type": "string" }, "type": "array" }, "block_key": { "description": "Stable question-block key. Send it unchanged when updating an answer.", "maxLength": 64, "minLength": 1, "type": "string" }, "block_label": { "description": "User-facing question or group name.", "type": "string" }, "field_key": { "description": "Stable field key. Send it unchanged with its block_key when updating the answer.", "maxLength": 512, "minLength": 1, "type": "string" }, "field_label": { "description": "User-facing field name.", "type": "string" }, "is_required": { "description": "Whether this answer is required when visible.", "type": "boolean" }, "schema_key": { "description": "Stable schema identity for interpreting this answer.", "maxLength": 512, "minLength": 1, "type": "string" }, "section_key": { "description": "Stable section key used to filter later reads.", "maxLength": 255, "minLength": 1, "type": "string" }, "section_label": { "description": "User-facing section name.", "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ], "description": "Current answer value, or null when unanswered." }, "value_type": { "description": "Expected kind of answer value.", "maxLength": 36, "minLength": 1, "type": "string" } }, "required": [ "section_key", "section_label", "block_key", "block_label", "schema_key", "field_key", "field_label", "value_type", "is_required", "allowed_values", "value" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "description": "Always null; this collection supports forward paging only.", "type": "null" } }, "required": [ "object", "items", "next_cursor", "previous_cursor", "answers_revision" ], "type": "object" }, "DealApplicationAutofillPreparation": { "additionalProperties": false, "properties": { "ai_mode": { "enum": [ "fast", "thinking" ], "type": "string" }, "application": { "additionalProperties": false, "properties": { "id": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "object": { "const": "deal_application", "type": "string" } }, "required": [ "id", "object" ], "type": "object" }, "can_start": { "type": "boolean" }, "evidence_sources": { "items": { "additionalProperties": false, "properties": { "family": { "type": "string" }, "id": { "type": "string" }, "label": { "type": [ "string", "null" ] }, "secondary_label": { "type": [ "string", "null" ] }, "selected_by_default": { "type": "boolean" } }, "required": [ "id", "family", "label", "secondary_label", "selected_by_default" ], "type": "object" }, "type": "array" }, "file_count": { "minimum": 0, "type": "integer" }, "files": { "description": "Supporting documents in preparation order, with their current processing status.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Document name shown in the Portal.", "example": "financial-statement.pdf", "type": [ "string", "null" ] }, "status": { "description": "Document processing: pending is queued; running is reading the file; success is ready for Autofill; failed needs attention.", "enum": [ "pending", "running", "success", "failed" ], "type": "string" } }, "required": [ "name", "status" ], "type": "object" }, "type": "array" }, "object": { "const": "deal_application_autofill_preparation", "type": "string" }, "revision": { "minimum": 1, "type": "integer" }, "selected_evidence_source_count": { "minimum": 0, "type": "integer" }, "start_url": { "format": "uri", "type": "string" }, "text_input": { "type": [ "string", "null" ] }, "uploaded_file": { "type": "object" } }, "required": [ "object", "application", "start_url", "revision", "text_input", "ai_mode", "file_count", "files", "selected_evidence_source_count", "evidence_sources", "can_start" ], "type": "object" }, "DealApplicationAutofillRun": { "additionalProperties": false, "properties": { "application": { "additionalProperties": false, "properties": { "id": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "object": { "const": "deal_application", "type": "string" } }, "required": [ "id", "object" ], "type": "object" }, "attempt_sequence": { "minimum": 1, "type": [ "integer", "null" ] }, "can_retry": { "type": "boolean" }, "created_at": { "format": "date-time", "type": "string" }, "failure": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" } }, "required": [ "code", "message", "retryable" ], "type": [ "object", "null" ] }, "id": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" }, "object": { "const": "deal_application_autofill_run", "type": "string" }, "progress": { "additionalProperties": false, "properties": { "completed_units": { "minimum": 0, "type": "integer" }, "step": { "type": "string" }, "total_units": { "minimum": 0, "type": [ "integer", "null" ] } }, "required": [ "step", "completed_units", "total_units" ], "type": "object" }, "retry_url": { "format": "uri", "type": "string" }, "status": { "enum": [ "pending", "running", "completed", "failed" ], "type": "string" }, "suggestion_count": { "minimum": 0, "type": "integer" }, "suggestions_url": { "format": "uri", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "format": "uri", "type": "string" }, "warning_count": { "minimum": 0, "type": "integer" } }, "required": [ "id", "object", "application", "status", "progress", "suggestion_count", "warning_count", "can_retry", "attempt_sequence", "failure", "created_at", "updated_at", "url", "suggestions_url", "retry_url" ], "type": "object" }, "DealApplicationAutofillSuggestion": { "additionalProperties": false, "properties": { "concerns": { "items": { "type": "object" }, "type": "array" }, "created_at": { "format": "date-time", "type": "string" }, "current_value": {}, "display_order": { "minimum": 0, "type": "integer" }, "field_label": { "type": [ "string", "null" ] }, "id": { "pattern": "^afsug_[a-z0-9]+$", "type": "string" }, "object": { "const": "deal_application_autofill_suggestion", "type": "string" }, "proposed_value": {}, "question_label": { "type": [ "string", "null" ] }, "run": { "type": "object" }, "section_label": { "type": [ "string", "null" ] }, "source": { "type": "object" }, "status": { "enum": [ "pending", "accepted", "dismissed", "stale", "failed" ], "type": "string" }, "suggestion_kind": { "type": "string" }, "target_attribute": { "type": "string" }, "target_scope": { "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "run", "status", "section_label", "question_label", "field_label", "display_order", "suggestion_kind", "target_attribute", "target_scope", "current_value", "proposed_value", "source", "concerns", "created_at", "updated_at" ], "type": "object" }, "DealApplicationAutofillSuggestionAcceptance": { "additionalProperties": false, "properties": { "answers_revision": { "description": "Use this revision for the next application-answer write.", "minimum": 0, "type": "integer" }, "suggestion": { "$ref": "#/components/schemas/DealApplicationAutofillSuggestion" } }, "required": [ "suggestion", "answers_revision" ], "type": "object" }, "DealApplicationAutofillSuggestionPage": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/DealApplicationAutofillSuggestion" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "type": [ "string", "null" ] } }, "required": [ "object", "items", "next_cursor", "previous_cursor" ], "type": "object" }, "DealApplicationContract": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "application_name": { "type": "string" }, "contract_version": { "type": "string" }, "description": { "type": "string" }, "instructions": { "type": "string" }, "object": { "const": "application_contract", "type": "string" }, "operations": { "additionalProperties": false, "properties": { "file_uploads_url": { "format": "uri", "type": "string" }, "files_url": { "format": "uri", "type": "string" }, "read_answers_url": { "format": "uri", "type": "string" }, "repeatable_items_url": { "format": "uri", "type": "string" }, "submit_url": { "format": "uri", "type": "string" }, "update_answers_url": { "format": "uri", "type": "string" } }, "required": [ "read_answers_url", "update_answers_url", "repeatable_items_url", "file_uploads_url", "files_url", "submit_url" ], "type": "object" }, "questions": { "items": { "additionalProperties": false, "properties": { "answer_operations": { "items": { "enum": [ "read", "update", "upload", "delete" ], "type": "string" }, "type": "array" }, "answer_shape": { "enum": [ "field", "selection_list", "file" ], "type": "string" }, "block_key": { "type": "string" }, "fields": { "items": { "additionalProperties": false, "properties": { "example": {}, "field_key": { "type": "string" }, "help_text": { "type": [ "string", "null" ] }, "is_required": { "type": "boolean" }, "label": { "type": "string" }, "value_schema": { "type": "object" } }, "required": [ "field_key", "label", "help_text", "is_required", "value_schema", "example" ], "type": "object" }, "type": "array" }, "help_text": { "type": [ "string", "null" ] }, "is_repeatable": { "type": "boolean" }, "is_required": { "type": "boolean" }, "kind": { "type": "string" }, "label": { "type": "string" }, "order": { "type": "integer" }, "parent_block_key": { "type": [ "string", "null" ] }, "schema_key": { "type": "string" }, "section_key": { "type": "string" }, "visibility": { "type": "object" } }, "required": [ "block_key", "schema_key", "section_key", "parent_block_key", "kind", "label", "help_text", "is_required", "is_repeatable", "answer_shape", "order", "answer_operations", "visibility", "fields" ], "type": "object" }, "type": "array" }, "repeatable_groups": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "item_operations": { "items": { "enum": [ "list", "create", "update", "delete" ], "type": "string" }, "type": "array" }, "item_question_keys": { "items": { "type": "string" }, "type": "array" }, "max_items": { "minimum": 0, "type": [ "integer", "null" ] }, "min_items": { "minimum": 0, "type": [ "integer", "null" ] }, "parent_block_key": { "type": [ "string", "null" ] }, "section_key": { "type": "string" } }, "required": [ "block_key", "section_key", "parent_block_key", "min_items", "max_items", "item_question_keys", "item_operations" ], "type": "object" }, "type": "array" }, "resource": { "additionalProperties": false, "properties": { "id": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "object": { "const": "deal_application", "type": "string" } }, "required": [ "id", "object" ], "type": "object" }, "sections": { "items": { "additionalProperties": false, "properties": { "label": { "type": "string" }, "order": { "type": "integer" }, "section_key": { "type": "string" } }, "required": [ "section_key", "label", "order" ], "type": "object" }, "type": "array" } }, "required": [ "object", "contract_version", "answers_revision", "application_name", "description", "sections", "repeatable_groups", "questions", "resource", "operations", "instructions" ], "type": "object" }, "DealApplicationDecision": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "id": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "object": { "const": "deal_application", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "status": { "example": "is_declined", "type": [ "string", "null" ] } }, "required": [ "id", "object", "revision", "answers_revision", "status" ], "type": "object" }, "DealApplicationDecisionOptions": { "additionalProperties": false, "properties": { "actions": { "items": { "additionalProperties": false, "properties": { "action": { "enum": [ "decline", "fund", "withdraw", "timeout", "reopen", "mark_submitted", "mark_not_submitted" ], "type": "string" }, "url": { "example": "https://api.levr.ai/v1/deal-applications/dapp_7fj3k9m2d8q4n6wx/decline/", "format": "uri", "type": "string" } }, "required": [ "action", "url" ], "type": "object" }, "maxItems": 7, "type": "array" }, "answers_revision": { "minimum": 0, "type": "integer" }, "id": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "object": { "const": "deal_application_decision_options", "type": "string" }, "recipients": { "items": { "additionalProperties": false, "properties": { "email": { "example": "broker@example.com", "format": "email", "maxLength": 254, "type": "string" }, "name": { "example": "Alex Morgan", "type": "string" }, "origin": { "enum": [ "organization", "source_provider", "processing_provider" ], "type": "string" } }, "required": [ "email", "origin", "name" ], "type": "object" }, "maxItems": 100, "type": "array" }, "revision": { "minimum": 0, "type": "integer" }, "status": { "example": "is_declined", "type": [ "string", "null" ] } }, "required": [ "id", "object", "revision", "answers_revision", "status", "actions", "recipients" ], "type": "object" }, "DealPage": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/Deal" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "type": [ "string", "null" ] } }, "required": [ "object", "items", "next_cursor", "previous_cursor" ], "type": "object" }, "DealParticipants": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "company_name": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "email": { "type": "string" }, "frontend_link": { "format": "uri", "type": [ "string", "null" ] }, "full_name": { "type": "string" }, "id": { "pattern": "^pers_[a-z0-9]+$", "type": "string" }, "is_do_not_contact": { "type": "boolean" }, "is_primary": { "type": "boolean" }, "job_title": { "type": "string" }, "notes": { "type": "string" }, "object": { "const": "person", "type": "string" }, "owner": { "anyOf": [ { "additionalProperties": false, "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "required": [ "email", "name" ], "type": "object" }, { "type": "null" } ] }, "phone_number": { "type": "string" }, "tags": { "items": { "additionalProperties": false, "properties": { "color": { "example": "#5B5BD6", "type": [ "string", "null" ] }, "id": { "pattern": "^ptag_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name", "color" ], "type": "object" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "full_name", "email", "phone_number", "company_name", "job_title", "is_do_not_contact", "notes", "owner", "tags", "created_at", "updated_at", "frontend_link", "is_primary" ], "type": "object" }, "type": "array" }, "object": { "const": "participant_list", "type": "string" }, "revision": { "minimum": 0, "type": "integer" } }, "required": [ "object", "items", "revision" ], "type": "object" }, "DealProjectAssociation": { "additionalProperties": false, "properties": { "deal_id": { "pattern": "^deal_[a-z0-9]+$", "type": "string" }, "project_id": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, "required": [ "deal_id", "project_id" ], "type": "object" }, "DealRecipient": { "additionalProperties": false, "properties": { "can_create_deal": { "type": "boolean" }, "id": { "example": "northstar-finance", "maxLength": 64, "pattern": "^[a-zA-Z0-9_-]{1,64}$", "type": "string" }, "name": { "example": "Northstar Finance", "type": "string" }, "object": { "const": "deal_recipient", "type": "string" }, "unavailable_reason": { "type": [ "string", "null" ] } }, "required": [ "id", "object", "name", "can_create_deal", "unavailable_reason" ], "type": "object" }, "DealRecipientIdentity": { "additionalProperties": false, "properties": { "id": { "example": "northstar-finance", "maxLength": 64, "pattern": "^[a-zA-Z0-9_-]{1,64}$", "type": "string" }, "name": { "example": "Northstar Finance", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "DealRecipientPage": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/DealRecipient" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "type": [ "string", "null" ] } }, "required": [ "object", "items", "next_cursor", "previous_cursor" ], "type": "object" }, "DealStageTransition": { "additionalProperties": false, "properties": { "id": { "pattern": "^deal_[a-z0-9]+$", "type": "string" }, "object": { "const": "deal", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "stage": { "additionalProperties": false, "properties": { "id": { "pattern": "^dstg_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "stage", "revision", "updated_at" ], "type": "object" }, "DealTerms": { "additionalProperties": false, "properties": { "deal": { "type": "object" }, "object": { "const": "deal_terms", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "terms": { "additionalProperties": false, "properties": { "actual_interest_rate": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "additional_notes": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "advance_rate_percent": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "advisory_fee_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "advisory_fee_percent": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "buy_rate": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "commission_actual_payment_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ] }, "commission_notes": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "commission_status": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "pattern": "^[A-Za-z]{3}$", "type": "string" }, { "type": "null" } ] }, "deal_length_interval": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "deal_length_value": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "deal_revenue": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "deal_status": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "deal_type": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "disbursed_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ] }, "equipment_entries": { "description": "The complete equipment list. Replaces the existing list when supplied; [] clears it.", "items": { "additionalProperties": false, "properties": { "equipment_condition": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ] }, "equipment_description": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "equipment_manufacturer_make_model": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "equipment_structure": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "equipment_type": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ] }, "equipment_value_or_cost": { "anyOf": [ { "pattern": "^[0-9]{1,10}(?:\\.[0-9]{1,2})?$", "type": "string" }, { "type": "null" } ] }, "equipment_vendor_or_supplier": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "position": { "minimum": 0, "type": "integer" } }, "type": "object" }, "maxItems": 100, "type": "array" }, "factor_rate": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "financing_type": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "funded_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "is_stacked_deal": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "is_syndication": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "maturity_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ] }, "net_funded_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "not_applicable_fields": { "items": { "type": "string" }, "maxItems": 64, "type": "array" }, "notes_to_accounting": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "nr_payments": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "offered_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "origination_fee_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "origination_fee_percent": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "other_fee": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "other_fee_description": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "payment_frequency_interval": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "processing_fee": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "property_loan_to_value": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "property_type": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "property_use": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "property_value": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "proposed_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "real_estate_property_address": { "anyOf": [ { "maxProperties": 64, "type": "object" }, { "type": "null" } ] }, "renewal_followup_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ] }, "repayment_holdback_percentage": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "repayment_payment_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "requested_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "sell_rate": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "stacked_with": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "syndication_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "syndication_percent": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "target_interest_rate": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "total_repayment_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] } }, "type": "object" } }, "required": [ "object", "deal", "revision", "terms" ], "type": "object" }, "ExternalApiConnection": { "additionalProperties": false, "properties": { "api_key": { "additionalProperties": false, "properties": { "id": { "pattern": "^key_[a-z0-9]+$", "type": "string" }, "label": { "type": "string" }, "masked": { "type": "string" }, "object": { "const": "api_key", "type": "string" } }, "required": [ "id", "object", "label", "masked" ], "type": "object" }, "api_version": { "const": "v1", "type": "string" }, "object": { "const": "api_connection", "type": "string" }, "provider": { "additionalProperties": false, "description": "The Portal this API key connects to.", "properties": { "id": { "pattern": "^[a-zA-Z0-9_-]{1,64}$", "type": "string" }, "name": { "type": "string" }, "object": { "const": "provider", "type": "string" } }, "required": [ "id", "object", "name" ], "type": "object" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "resources": { "items": { "additionalProperties": false, "properties": { "access": { "enum": [ "none", "read", "write" ], "type": "string" }, "resource": { "type": "string" } }, "required": [ "resource", "access" ], "type": "object" }, "type": "array" } }, "required": [ "object", "api_version", "request_id", "api_key", "provider", "resources" ], "type": "object" }, "ExternalApiError": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" }, "Lender": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "id": { "pattern": "^lndr_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" }, "object": { "const": "lender", "type": "string" }, "offering_count": { "minimum": 0, "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "website": { "type": "string" } }, "required": [ "id", "object", "name", "description", "website", "offering_count", "created_at", "updated_at" ], "type": "object" }, "LenderDetail": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "id": { "pattern": "^lndr_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" }, "object": { "const": "lender", "type": "string" }, "offering_count": { "minimum": 0, "type": "integer" }, "offerings": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "eligibility_criteria": { "type": "string" }, "id": { "pattern": "^loff_[a-z0-9]+$", "type": "string" }, "key_features": { "type": "string" }, "object": { "const": "lender_offering", "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "object", "type", "description", "key_features", "eligibility_criteria" ], "type": "object" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" }, "website": { "type": "string" } }, "required": [ "id", "object", "name", "description", "website", "offering_count", "created_at", "updated_at", "offerings" ], "type": "object" }, "LenderOffering": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "eligibility_criteria": { "type": "string" }, "id": { "pattern": "^loff_[a-z0-9]+$", "type": "string" }, "key_features": { "type": "string" }, "object": { "const": "lender_offering", "type": "string" }, "type": { "type": "string" } }, "required": [ "id", "object", "type", "description", "key_features", "eligibility_criteria" ], "type": "object" }, "LenderPage": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "type": "string" }, "description": { "type": "string" }, "id": { "pattern": "^lndr_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" }, "object": { "const": "lender", "type": "string" }, "offering_count": { "minimum": 0, "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "website": { "type": "string" } }, "required": [ "id", "object", "name", "description", "website", "offering_count", "created_at", "updated_at" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "type": [ "string", "null" ] } }, "required": [ "object", "items", "next_cursor", "previous_cursor" ], "type": "object" }, "MatchmakingRun": { "additionalProperties": false, "properties": { "answers_revision": { "type": [ "integer", "null" ] }, "attempt_sequence": { "type": [ "integer", "null" ] }, "coverage": { "type": "object" }, "created_at": { "format": "date-time", "type": "string" }, "id": { "pattern": "^pmrun_[a-z0-9]+$", "type": "string" }, "impactful_missing_fields": { "items": { "type": "object" }, "type": "array" }, "is_stale": { "type": "boolean" }, "object": { "const": "project_matchmaking_run", "type": "string" }, "project": { "type": "object" }, "results_url": { "format": "uri", "type": "string" }, "sequence": { "minimum": 1, "type": "integer" }, "status": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "id", "object", "project", "sequence", "status", "coverage", "impactful_missing_fields", "answers_revision", "is_stale", "attempt_sequence", "created_at", "updated_at", "url", "results_url" ], "type": "object" }, "Person": { "additionalProperties": false, "properties": { "company_name": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "email": { "type": "string" }, "frontend_link": { "format": "uri", "type": [ "string", "null" ] }, "full_name": { "type": "string" }, "id": { "pattern": "^pers_[a-z0-9]+$", "type": "string" }, "is_do_not_contact": { "type": "boolean" }, "job_title": { "type": "string" }, "notes": { "type": "string" }, "object": { "const": "person", "type": "string" }, "owner": { "type": [ "object", "null" ] }, "phone_number": { "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "tags": { "items": { "type": "object" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "full_name", "email", "phone_number", "company_name", "job_title", "is_do_not_contact", "notes", "owner", "tags", "created_at", "updated_at", "frontend_link" ], "type": "object" }, "PersonPage": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "company_name": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "email": { "type": "string" }, "frontend_link": { "format": "uri", "type": [ "string", "null" ] }, "full_name": { "type": "string" }, "id": { "pattern": "^pers_[a-z0-9]+$", "type": "string" }, "is_do_not_contact": { "type": "boolean" }, "job_title": { "type": "string" }, "notes": { "type": "string" }, "object": { "const": "person", "type": "string" }, "owner": { "type": [ "object", "null" ] }, "phone_number": { "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "tags": { "items": { "type": "object" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "full_name", "email", "phone_number", "company_name", "job_title", "is_do_not_contact", "notes", "owner", "tags", "created_at", "updated_at", "frontend_link" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "type": [ "string", "null" ] } }, "required": [ "object", "items", "next_cursor", "previous_cursor" ], "type": "object" }, "Project": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": [ "integer", "null" ] }, "answers_url": { "format": "uri", "type": "string" }, "autofill_preparation_url": { "format": "uri", "type": "string" }, "autofill_runs_url": { "format": "uri", "type": "string" }, "business": { "type": "object" }, "contract_url": { "format": "uri", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "decision_due_date": { "format": "date", "type": [ "string", "null" ] }, "flexibility_notes": { "type": "string" }, "id": { "pattern": "^proj_[a-z0-9]+$", "type": "string" }, "is_sample": { "description": "A fictional onboarding example.", "type": "boolean" }, "name": { "type": "string" }, "object": { "const": "project", "type": "string" }, "purpose": { "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "stage": { "type": "object" }, "target": { "type": [ "object", "null" ] }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "id", "object", "name", "business", "stage", "revision", "answers_revision", "created_at", "updated_at", "url", "answers_url", "contract_url", "autofill_preparation_url", "autofill_runs_url" ], "type": "object" }, "ProjectMatchmakingAnswerMutation": { "additionalProperties": false, "properties": { "affected_section_keys": { "items": { "type": "string" }, "type": "array" }, "answers_revision": { "minimum": 0, "type": "integer" }, "object": { "const": "project_matchmaking_application_answers", "type": "string" }, "updated_answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "maxLength": 64, "minLength": 1, "type": "string" }, "field_key": { "maxLength": 512, "minLength": 1, "type": "string" }, "schema_key": { "maxLength": 512, "minLength": 1, "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] } }, "required": [ "block_key", "schema_key", "field_key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "object", "answers_revision", "updated_answers", "affected_section_keys" ], "type": "object" }, "ProjectMatchmakingAnswerPage": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "items": { "items": { "additionalProperties": false, "properties": { "allowed_values": { "description": "Allowed choices for this answer, or an empty list when choices are not restricted.", "items": { "maxLength": 255, "type": "string" }, "type": "array" }, "block_key": { "description": "Stable question-block key. Send it unchanged when updating an answer.", "maxLength": 64, "minLength": 1, "type": "string" }, "block_label": { "description": "User-facing question or group name.", "type": "string" }, "field_key": { "description": "Stable field key. Send it unchanged with its block_key when updating the answer.", "maxLength": 512, "minLength": 1, "type": "string" }, "field_label": { "description": "User-facing field name.", "type": "string" }, "is_required": { "description": "Whether this answer is required when visible.", "type": "boolean" }, "schema_key": { "description": "Stable schema identity for interpreting this answer.", "maxLength": 512, "minLength": 1, "type": "string" }, "section_key": { "description": "Stable section key used to filter later reads.", "maxLength": 255, "minLength": 1, "type": "string" }, "section_label": { "description": "User-facing section name.", "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ], "description": "Current answer value, or null when unanswered." }, "value_type": { "description": "Expected kind of answer value.", "maxLength": 36, "minLength": 1, "type": "string" } }, "required": [ "section_key", "section_label", "block_key", "block_label", "schema_key", "field_key", "field_label", "value_type", "is_required", "allowed_values", "value" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "description": "Always null; this collection supports forward paging only.", "type": "null" } }, "required": [ "object", "items", "next_cursor", "previous_cursor", "answers_revision" ], "type": "object" }, "ProjectMatchmakingApplicationAutofillPreparation": { "additionalProperties": false, "properties": { "ai_mode": { "type": "string" }, "can_start": { "type": "boolean" }, "evidence_sources": { "items": { "additionalProperties": false, "properties": { "family": { "example": "runtime", "type": "string" }, "id": { "example": "runtime_current_application", "type": "string" }, "label": { "type": [ "string", "null" ] }, "secondary_label": { "example": "Current matchmaking application", "type": [ "string", "null" ] }, "selected_by_default": { "type": "boolean" } }, "required": [ "id", "family", "label", "secondary_label", "selected_by_default" ], "type": "object" }, "type": "array" }, "file_count": { "description": "Files already attached to this autofill preparation.", "minimum": 0, "type": "integer" }, "files": { "description": "Supporting documents in preparation order, with their current processing status.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Document name shown in the Portal.", "example": "financial-statement.pdf", "type": [ "string", "null" ] }, "status": { "description": "Document processing: pending is queued; running is reading the file; success is ready for Autofill; failed needs attention.", "enum": [ "pending", "running", "success", "failed" ], "type": "string" } }, "required": [ "name", "status" ], "type": "object" }, "type": "array" }, "object": { "const": "project_matchmaking_application_autofill_preparation", "type": "string" }, "project": { "type": "object" }, "revision": { "minimum": 1, "type": "integer" }, "selected_evidence_source_count": { "minimum": 0, "type": "integer" }, "start_url": { "format": "uri", "type": "string" }, "text_input": { "type": [ "string", "null" ] } }, "required": [ "object", "project", "revision", "text_input", "ai_mode", "file_count", "files", "selected_evidence_source_count", "can_start", "start_url", "evidence_sources" ], "type": "object" }, "ProjectMatchmakingApplicationAutofillPreparationFileUpload": { "additionalProperties": false, "properties": { "ai_mode": { "type": "string" }, "can_start": { "type": "boolean" }, "evidence_sources": { "items": { "additionalProperties": false, "properties": { "family": { "example": "runtime", "type": "string" }, "id": { "example": "runtime_current_application", "type": "string" }, "label": { "type": [ "string", "null" ] }, "secondary_label": { "example": "Current matchmaking application", "type": [ "string", "null" ] }, "selected_by_default": { "type": "boolean" } }, "required": [ "id", "family", "label", "secondary_label", "selected_by_default" ], "type": "object" }, "type": "array" }, "file_count": { "description": "Files already attached to this autofill preparation.", "minimum": 0, "type": "integer" }, "files": { "description": "Supporting documents in preparation order, with their current processing status.", "items": { "additionalProperties": false, "properties": { "name": { "description": "Document name shown in the Portal.", "example": "financial-statement.pdf", "type": [ "string", "null" ] }, "status": { "description": "Document processing: pending is queued; running is reading the file; success is ready for Autofill; failed needs attention.", "enum": [ "pending", "running", "success", "failed" ], "type": "string" } }, "required": [ "name", "status" ], "type": "object" }, "type": "array" }, "object": { "const": "project_matchmaking_application_autofill_preparation", "type": "string" }, "project": { "type": "object" }, "revision": { "minimum": 1, "type": "integer" }, "selected_evidence_source_count": { "minimum": 0, "type": "integer" }, "start_url": { "format": "uri", "type": "string" }, "text_input": { "type": [ "string", "null" ] }, "uploaded_file": { "additionalProperties": false, "properties": { "name": { "type": "string" }, "status": { "type": "string" } }, "required": [ "name", "status" ], "type": "object" } }, "required": [ "object", "project", "revision", "text_input", "ai_mode", "file_count", "files", "selected_evidence_source_count", "can_start", "start_url", "evidence_sources", "uploaded_file" ], "type": "object" }, "ProjectMatchmakingApplicationAutofillRun": { "additionalProperties": false, "properties": { "attempt_sequence": { "minimum": 1, "type": [ "integer", "null" ] }, "can_retry": { "type": "boolean" }, "created_at": { "format": "date-time", "type": "string" }, "failure": { "type": [ "object", "null" ] }, "id": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" }, "object": { "const": "project_matchmaking_application_autofill_run", "type": "string" }, "progress": { "additionalProperties": false, "properties": { "completed_units": { "minimum": 0, "type": "integer" }, "step": { "type": "string" }, "total_units": { "minimum": 0, "type": "integer" } }, "required": [ "step", "completed_units", "total_units" ], "type": "object" }, "project": { "type": "object" }, "retry_url": { "format": "uri", "type": "string" }, "status": { "enum": [ "pending", "running", "completed", "failed" ], "type": "string" }, "suggestion_count": { "minimum": 0, "type": "integer" }, "suggestions_url": { "format": "uri", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "url": { "format": "uri", "type": "string" }, "warning_count": { "minimum": 0, "type": "integer" } }, "required": [ "id", "object", "project", "status", "progress", "suggestion_count", "warning_count", "can_retry", "attempt_sequence", "failure", "created_at", "updated_at", "url", "suggestions_url", "retry_url" ], "type": "object" }, "ProjectMatchmakingApplicationAutofillSuggestion": { "additionalProperties": false, "properties": { "concerns": { "items": { "type": "object" }, "type": "array" }, "created_at": { "format": "date-time", "type": "string" }, "current_value": {}, "display_order": { "type": "integer" }, "field_label": { "type": [ "string", "null" ] }, "id": { "pattern": "^afsug_[a-z0-9]+$", "type": "string" }, "object": { "const": "project_matchmaking_application_autofill_suggestion", "type": "string" }, "proposed_value": {}, "question_label": { "type": [ "string", "null" ] }, "run": { "type": "object" }, "section_label": { "type": [ "string", "null" ] }, "source": { "type": "object" }, "status": { "enum": [ "pending", "accepted", "dismissed", "stale", "failed" ], "type": "string" }, "suggestion_kind": { "type": "string" }, "target_attribute": { "type": "string" }, "target_scope": { "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "run", "status", "section_label", "question_label", "field_label", "display_order", "suggestion_kind", "target_attribute", "target_scope", "current_value", "proposed_value", "source", "concerns", "created_at", "updated_at" ], "type": "object" }, "ProjectMatchmakingApplicationAutofillSuggestionAcceptance": { "additionalProperties": false, "properties": { "answers_revision": { "description": "Use this revision for the next application-answer write.", "minimum": 0, "type": "integer" }, "suggestion": { "$ref": "#/components/schemas/ProjectMatchmakingApplicationAutofillSuggestion" } }, "required": [ "suggestion", "answers_revision" ], "type": "object" }, "ProjectMatchmakingApplicationAutofillSuggestionPage": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/ProjectMatchmakingApplicationAutofillSuggestion" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "type": [ "string", "null" ] } }, "required": [ "object", "items", "next_cursor", "previous_cursor" ], "type": "object" }, "ProjectMatchmakingApplicationContract": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "application_name": { "type": "string" }, "contract_version": { "type": "string" }, "description": { "type": "string" }, "instructions": { "type": "string" }, "object": { "const": "application_contract", "type": "string" }, "operations": { "additionalProperties": false, "properties": { "calculate_matches_url": { "format": "uri", "type": "string" }, "file_uploads_url": { "format": "uri", "type": "string" }, "files_url": { "format": "uri", "type": "string" }, "read_answers_url": { "format": "uri", "type": "string" }, "repeatable_items_url": { "format": "uri", "type": "string" }, "update_answers_url": { "format": "uri", "type": "string" } }, "required": [ "read_answers_url", "update_answers_url", "repeatable_items_url", "file_uploads_url", "files_url", "calculate_matches_url" ], "type": "object" }, "questions": { "items": { "additionalProperties": false, "properties": { "answer_operations": { "items": { "enum": [ "read", "update", "upload", "delete" ], "type": "string" }, "type": "array" }, "answer_shape": { "enum": [ "field", "selection_list", "file" ], "type": "string" }, "block_key": { "type": "string" }, "fields": { "items": { "additionalProperties": false, "properties": { "example": {}, "field_key": { "type": "string" }, "help_text": { "type": [ "string", "null" ] }, "is_required": { "type": "boolean" }, "label": { "type": "string" }, "value_schema": { "type": "object" } }, "required": [ "field_key", "label", "help_text", "is_required", "value_schema", "example" ], "type": "object" }, "type": "array" }, "help_text": { "type": [ "string", "null" ] }, "is_repeatable": { "type": "boolean" }, "is_required": { "type": "boolean" }, "kind": { "type": "string" }, "label": { "type": "string" }, "order": { "type": "integer" }, "parent_block_key": { "type": [ "string", "null" ] }, "schema_key": { "type": "string" }, "section_key": { "type": "string" }, "visibility": { "type": "object" } }, "required": [ "block_key", "schema_key", "section_key", "parent_block_key", "kind", "label", "help_text", "is_required", "is_repeatable", "answer_shape", "order", "answer_operations", "visibility", "fields" ], "type": "object" }, "type": "array" }, "repeatable_groups": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "item_operations": { "items": { "enum": [ "list", "create", "update", "delete" ], "type": "string" }, "type": "array" }, "item_question_keys": { "items": { "type": "string" }, "type": "array" }, "max_items": { "minimum": 0, "type": [ "integer", "null" ] }, "min_items": { "minimum": 0, "type": [ "integer", "null" ] }, "parent_block_key": { "type": [ "string", "null" ] }, "section_key": { "type": "string" } }, "required": [ "block_key", "section_key", "parent_block_key", "min_items", "max_items", "item_question_keys", "item_operations" ], "type": "object" }, "type": "array" }, "resource": { "additionalProperties": false, "properties": { "id": { "pattern": "^proj_[a-z0-9]+$", "type": "string" }, "object": { "const": "project_matchmaking_application", "type": "string" } }, "required": [ "id", "object" ], "type": "object" }, "sections": { "items": { "additionalProperties": false, "properties": { "label": { "type": "string" }, "order": { "type": "integer" }, "section_key": { "type": "string" } }, "required": [ "section_key", "label", "order" ], "type": "object" }, "type": "array" } }, "required": [ "object", "contract_version", "answers_revision", "application_name", "description", "sections", "repeatable_groups", "questions", "resource", "operations", "instructions" ], "type": "object" }, "ProjectMatchmakingRequest": { "additionalProperties": false, "properties": { "request_details": { "additionalProperties": false, "example": { "decision_due_date": "2026-11-30", "flexibility_notes": "Equipment can be purchased in two phases.", "purpose": "Purchase equipment for the new workshop", "target_amount": "250000.00", "target_currency": "CAD" }, "minProperties": 1, "properties": { "decision_due_date": { "format": "date", "type": [ "string", "null" ] }, "flexibility_notes": { "type": [ "string", "null" ] }, "purpose": { "type": [ "string", "null" ] }, "target_amount": { "type": [ "string", "null" ] }, "target_currency": { "type": [ "string", "null" ] } }, "type": "object" }, "workspace_revision": { "type": "integer" } }, "required": [ "request_details", "workspace_revision" ], "type": "object" }, "ProjectMatchmakingResultPage": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "availability": { "type": "string" }, "classification": { "type": [ "string", "null" ] }, "created_at": { "format": "date-time", "type": "string" }, "evaluation": { "additionalProperties": false, "properties": { "classification": { "enum": [ "match", "partial_fit", "insufficient_information", "not_a_match", "not_assessed", null ], "type": [ "string", "null" ] }, "confidence": { "enum": [ "low", "medium", "high", null ], "type": [ "string", "null" ] }, "evaluation_depth": { "enum": [ "classify", "enrich", null ], "type": [ "string", "null" ] }, "evidence": { "items": { "additionalProperties": false, "properties": { "claim": { "type": "string" }, "label": { "maxLength": 48, "type": "string" }, "source_references": { "items": { "type": "string" }, "type": "array" } }, "required": [ "claim", "source_references" ], "type": "object" }, "type": "array" }, "fit_factors": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "key": { "type": "string" }, "label": { "type": "string" }, "source_references": { "items": { "type": "string" }, "type": "array" } }, "required": [ "key", "label", "description", "source_references" ], "type": "object" }, "type": "array" }, "goal_relevance": { "additionalProperties": false, "properties": { "category": { "enum": [ "direct", "alternative", "unrelated", "unknown" ], "type": "string" }, "claim": { "type": "string" }, "source_references": { "items": { "type": "string" }, "type": "array" } }, "required": [ "category", "claim", "source_references" ], "type": "object" }, "missing_fields": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "field_label": { "type": "string" }, "help_text": { "type": "string" }, "question_label": { "type": "string" }, "section_key": { "type": "string" }, "section_label": { "type": "string" } }, "required": [ "field_key", "block_key", "section_key", "section_label", "question_label", "field_label", "help_text" ], "type": "object" }, "type": "array" }, "missing_runtime_keys": { "items": { "type": "string" }, "type": "array" }, "offering_evaluations": { "items": { "additionalProperties": false, "properties": { "classification": { "enum": [ "match", "partial_fit", "insufficient_information", "not_a_match", "not_assessed" ], "type": "string" }, "confidence": { "enum": [ "low", "medium", "high" ], "type": "string" }, "evidence": { "items": { "additionalProperties": false, "properties": { "claim": { "type": "string" }, "label": { "maxLength": 48, "type": "string" }, "source_references": { "items": { "type": "string" }, "type": "array" } }, "required": [ "claim", "source_references" ], "type": "object" }, "type": "array" }, "fit_factors": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "key": { "type": "string" }, "label": { "type": "string" }, "source_references": { "items": { "type": "string" }, "type": "array" } }, "required": [ "key", "label", "description", "source_references" ], "type": "object" }, "type": "array" }, "missing_fields": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "field_label": { "type": "string" }, "help_text": { "type": "string" }, "question_label": { "type": "string" }, "section_key": { "type": "string" }, "section_label": { "type": "string" } }, "required": [ "field_key", "block_key", "section_key", "section_label", "question_label", "field_label", "help_text" ], "type": "object" }, "type": "array" }, "missing_runtime_keys": { "items": { "type": "string" }, "type": "array" }, "offering_key": { "type": "string" }, "offering_name": { "type": "string" }, "requirements": { "items": { "additionalProperties": false, "properties": { "claim": { "type": "string" }, "label": { "maxLength": 48, "type": "string" }, "source_references": { "items": { "type": "string" }, "type": "array" } }, "required": [ "claim", "source_references" ], "type": "object" }, "type": "array" }, "summary": { "type": "string" }, "summary_source_references": { "items": { "type": "string" }, "type": "array" }, "uncertainties": { "items": { "type": "string" }, "type": "array" } }, "required": [ "offering_key", "offering_name", "classification", "confidence", "summary", "summary_source_references", "evidence", "fit_factors", "uncertainties", "requirements", "missing_runtime_keys", "missing_fields" ], "type": "object" }, "type": "array" }, "requirements": { "items": { "additionalProperties": false, "properties": { "claim": { "type": "string" }, "label": { "maxLength": 48, "type": "string" }, "source_references": { "items": { "type": "string" }, "type": "array" } }, "required": [ "claim", "source_references" ], "type": "object" }, "type": "array" }, "schema_version": { "const": 1, "type": "integer" }, "summary": { "type": "string" }, "summary_source_references": { "items": { "type": "string" }, "type": "array" }, "uncertainties": { "items": { "type": "string" }, "type": "array" } }, "required": [ "schema_version", "classification", "confidence", "summary", "summary_source_references", "evidence", "fit_factors", "uncertainties", "requirements", "missing_runtime_keys", "missing_fields", "offering_evaluations" ], "type": "object" }, "id": { "pattern": "^pmres_[a-z0-9]+$", "type": "string" }, "is_selected": { "type": "boolean" }, "object": { "const": "project_matchmaking_result", "type": "string" }, "package_version": { "type": "integer" }, "recipient": { "additionalProperties": false, "properties": { "id": { "description": "Pass this id as recipient_id when creating a Deal. Null for historical results whose recipient is unavailable.", "example": "northstar-finance", "maxLength": 64, "minLength": 1, "type": [ "string", "null" ] }, "label": { "type": "string" }, "package": { "type": [ "object", "null" ] }, "provider": { "type": [ "object", "null" ] } }, "required": [ "id", "label", "provider", "package" ], "type": "object" }, "recipient_group": { "type": "string" }, "recipient_key": { "type": "string" }, "recipient_kind": { "type": "string" }, "status": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "recipient_key", "recipient_kind", "recipient_group", "recipient", "status", "package_version", "availability", "is_selected" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "type": [ "string", "null" ] } }, "required": [ "object", "items", "next_cursor", "previous_cursor" ], "type": "object" }, "ProjectMatchmakingSelections": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "package_version": { "minimum": 1, "type": "integer" }, "recipient_key": { "type": "string" }, "selected_at": { "format": "date-time", "type": "string" } }, "required": [ "recipient_key", "package_version", "selected_at" ], "type": "object" }, "type": "array" }, "object": { "const": "project_matchmaking_selections", "type": "string" }, "project": { "additionalProperties": false, "properties": { "id": { "pattern": "^proj_[a-z0-9]+$", "type": "string" }, "object": { "const": "project", "type": "string" } }, "required": [ "id", "object" ], "type": "object" }, "revision": { "minimum": 0, "type": "integer" }, "run": { "oneOf": [ { "type": "null" }, { "additionalProperties": false, "properties": { "id": { "pattern": "^pmrun_[a-z0-9]+$", "type": "string" }, "object": { "const": "project_matchmaking_run", "type": "string" } }, "required": [ "id", "object" ], "type": "object" } ] } }, "required": [ "object", "project", "run", "revision", "items" ], "type": "object" }, "ProjectPage": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/Project" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "type": [ "string", "null" ] } }, "required": [ "object", "items", "next_cursor", "previous_cursor" ], "type": "object" }, "ProjectStageTransition": { "additionalProperties": false, "properties": { "id": { "pattern": "^proj_[a-z0-9]+$", "type": "string" }, "object": { "const": "project", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "stage": { "additionalProperties": false, "properties": { "id": { "pattern": "^pstg_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "stage", "revision", "updated_at" ], "type": "object" }, "SourceChannel": { "additionalProperties": false, "properties": { "business_contract_url": { "format": "uri", "type": "string" }, "create_business_url": { "format": "uri", "type": "string" }, "id": { "pattern": "^srcch_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" }, "object": { "const": "source_channel", "type": "string" }, "readiness": { "additionalProperties": false, "properties": { "is_ready": { "type": "boolean" }, "message": { "type": "string" }, "reason": { "type": [ "string", "null" ] } }, "required": [ "is_ready", "reason", "message" ], "type": "object" } }, "required": [ "id", "object", "name", "readiness", "business_contract_url", "create_business_url" ], "type": "object" }, "SourceChannelBusinessContract": { "additionalProperties": false, "properties": { "contract_version": { "type": "integer" }, "create_business_url": { "format": "uri", "type": "string" }, "request_schema": { "type": "object" }, "source_channel": { "additionalProperties": false, "properties": { "id": { "pattern": "^srcch_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" }, "object": { "const": "source_channel", "type": "string" } }, "required": [ "id", "object", "name" ], "type": "object" } }, "required": [ "source_channel", "contract_version", "request_schema", "create_business_url" ], "type": "object" }, "SourceChannelPage": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/SourceChannel" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "type": [ "string", "null" ] } }, "required": [ "object", "items", "next_cursor", "previous_cursor" ], "type": "object" } }, "securitySchemes": { "apiKey": { "bearerFormat": "Levr API Key", "scheme": "bearer", "type": "http" } } }, "info": { "description": "Connect your systems to your Portal and receive signed webhook notifications.", "title": "Levr External API", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/": { "get": { "description": "Check which Portal this API key connects to and which resources it can read or update.", "operationId": "getExternalApiConnection", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalApiConnection" } } }, "description": "The API key is valid and its effective access is shown.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/connection/get-external-api-connection/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/connection/get-external-api-connection/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/connection/get-external-api-connection/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Verify an API connection" } }, "/business-pipelines/{pipeline_slug}/stages/": { "get": { "operationId": "getBusinessStageConfiguration", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "example": { "categories": [ { "description": "Linked application status: Action required. Existing status updates and notifications still apply.", "key": "action_required", "label": "Action required" } ], "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "stages": [ { "category_key": "action_required", "category_label": "Action required", "deletion_blocker": "Move the records in this stage before removing it.", "id": "bstg_a1b2c3d4e5f6g7h8", "name": "Preparing application", "object": "business_stage", "record_count": 3 } ] }, "properties": { "categories": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "key": { "type": "string" }, "label": { "type": "string" } }, "required": [ "key", "label", "description" ], "type": "object" }, "type": "array" }, "revision": { "type": "string" }, "stages": { "items": { "additionalProperties": false, "properties": { "category_key": { "maxLength": 100, "type": "string" }, "category_label": { "type": "string" }, "deletion_blocker": { "description": "Why this stage must remain in the workflow, or null when it can be removed.", "type": [ "string", "null" ] }, "id": { "pattern": "^bstg_[a-z0-9]+$", "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "object": { "const": "business_stage", "type": "string" }, "record_count": { "description": "Records referencing this stage, including records excluded from API collections. Used for stage removal checks; not a collection total.", "type": "integer" } }, "required": [ "id", "object", "name", "category_key", "category_label", "record_count", "deletion_blocker" ], "type": "object" }, "type": "array" } }, "required": [ "revision", "categories", "stages" ], "type": "object" } } }, "description": "Current provider workflows", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/business-pipelines/get-business-stage-configuration/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/business-pipelines/get-business-stage-configuration/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/business-pipelines/get-business-stage-configuration/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/business-pipelines/get-business-stage-configuration/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/business-pipelines/get-business-stage-configuration/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/business-pipelines/get-business-stage-configuration/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/business-pipelines/get-business-stage-configuration/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Read business stages" }, "parameters": [ { "in": "path", "name": "pipeline_slug", "required": true, "schema": { "pattern": "^bpipe_[a-z0-9]+$", "type": "string" } } ], "put": { "description": "Read first. Send the complete desired stage list and that workflow's expected_revision. Existing categories cannot change. Follow the stage creation fields in this resource schema. Omit a stage only when its deletion_blocker is null. Records are never moved by a configuration edit. Reuse Idempotency-Key only for an identical retry.", "operationId": "updateBusinessStageConfiguration", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "example": { "expected_revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "stages": [ { "category_key": "action_required", "id": "bstg_a1b2c3d4e5f6g7h8", "name": "Preparing application" }, { "category_key": "action_required", "copy_from_id": "bstg_a1b2c3d4e5f6g7h8", "name": "Waiting for documents" } ] }, "properties": { "expected_revision": { "maxLength": 64, "minLength": 64, "type": "string" }, "stages": { "items": { "additionalProperties": false, "properties": { "category_key": { "maxLength": 100, "type": "string" }, "copy_from_id": { "description": "Required for a new stage. Copy a stage from this business pipeline with the same category_key to preserve intake automation.", "pattern": "^bstg_[a-z0-9]+$", "type": "string" }, "id": { "pattern": "^bstg_[a-z0-9]+$", "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "name", "category_key" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "expected_revision", "stages" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "example": { "categories": [ { "description": "Linked application status: Action required. Existing status updates and notifications still apply.", "key": "action_required", "label": "Action required" } ], "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "stages": [ { "category_key": "action_required", "category_label": "Action required", "deletion_blocker": "Move the records in this stage before removing it.", "id": "bstg_a1b2c3d4e5f6g7h8", "name": "Preparing application", "object": "business_stage", "record_count": 3 } ] }, "properties": { "categories": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "key": { "type": "string" }, "label": { "type": "string" } }, "required": [ "key", "label", "description" ], "type": "object" }, "type": "array" }, "revision": { "type": "string" }, "stages": { "items": { "additionalProperties": false, "properties": { "category_key": { "maxLength": 100, "type": "string" }, "category_label": { "type": "string" }, "deletion_blocker": { "description": "Why this stage must remain in the workflow, or null when it can be removed.", "type": [ "string", "null" ] }, "id": { "pattern": "^bstg_[a-z0-9]+$", "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "object": { "const": "business_stage", "type": "string" }, "record_count": { "description": "Records referencing this stage, including records excluded from API collections. Used for stage removal checks; not a collection total.", "type": "integer" } }, "required": [ "id", "object", "name", "category_key", "category_label", "record_count", "deletion_blocker" ], "type": "object" }, "type": "array" } }, "required": [ "revision", "categories", "stages" ], "type": "object" } } }, "description": "Current provider workflows", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/business-pipelines/update-business-stage-configuration/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/business-pipelines/update-business-stage-configuration/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/business-pipelines/update-business-stage-configuration/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/business-pipelines/update-business-stage-configuration/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/business-pipelines/update-business-stage-configuration/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/business-pipelines/update-business-stage-configuration/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/business-pipelines/update-business-stage-configuration/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Manage one provider workflow" } }, "/businesses/": { "get": { "description": "Lists live businesses in this Portal. Fictional onboarding examples are excluded.", "operationId": "listBusinesses", "parameters": [ { "description": "Match a business name or operating name.", "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Comma-separated name, created_at, or updated_at; prefix - for descending.", "in": "query", "name": "ordering", "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "created_after", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "created_before", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "updated_after", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "updated_before", "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessPage" } } }, "description": "Businesses available to this provider API key.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/list-businesses/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/list-businesses/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/list-businesses/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/list-businesses/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List businesses" } }, "/businesses/{business_id}/": { "get": { "operationId": "getBusinessStatus", "parameters": [ { "in": "path", "name": "business_id", "required": true, "schema": { "pattern": "^biz_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessStatusResult" } } }, "description": "The business status visible in this portal.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-business-status/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-business-status/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-business-status/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-business-status/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-business-status/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-business-status/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Get a business and its portal status" }, "patch": { "description": "Change the name shown for this Business in your Portal. This does not rename the client's shared legal organization or alter intake answers or status. Read the Business first and pass its latest revision in If-Match.", "operationId": "updateBusiness", "parameters": [ { "in": "path", "name": "business_id", "required": true, "schema": { "pattern": "^biz_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "Northstar Foods — Growth Financing" }, "schema": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessStatusResult" } } }, "description": "The updated Business and its new revision.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/update-business/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/update-business/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/update-business/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/update-business/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/update-business/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/update-business/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/update-business/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/update-business/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Update a Business" } }, "/businesses/{business_id}/activation/": { "get": { "description": "Current request and application facts. Active unlinked service_request.slug values can be passed as service_request_id to POST /projects/. Recipient and observer workspaces return can_view=false.", "operationId": "getBusinessActivation", "parameters": [ { "in": "path", "name": "business_id", "required": true, "schema": { "pattern": "^biz_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "offset", "schema": { "minimum": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "can_view": { "type": "boolean" }, "next_offset": { "type": [ "integer", "null" ] }, "rows": { "items": { "additionalProperties": false, "properties": { "application_count": { "type": "integer" }, "can_start_project": { "type": "boolean" }, "client_applications": { "additionalProperties": false, "properties": { "incomplete": { "type": "integer" }, "submitted": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" }, "incomplete_application_count": { "type": "integer" }, "last_client_activity_at": { "format": "date-time", "type": [ "string", "null" ] }, "matching": { "properties": { "available_match_count": { "type": "integer" }, "client_enabled": { "type": "boolean" }, "is_running": { "type": "boolean" }, "is_stale": { "type": "boolean" }, "matched_count": { "type": "integer" }, "selected_count": { "type": "integer" }, "state": { "type": "string" } }, "type": "object" }, "progress": { "type": [ "object", "null" ] }, "project": { "properties": { "name": { "type": "string" }, "slug": { "type": "string" } }, "type": [ "object", "null" ] }, "service_request": { "properties": { "ended_at": { "format": "date-time", "type": [ "string", "null" ] }, "name": { "type": "string" }, "slug": { "type": "string" } }, "type": [ "object", "null" ] }, "target_amount": { "type": [ "string", "null" ] }, "target_currency": { "type": [ "string", "null" ] } }, "type": "object" }, "maxItems": 100, "type": "array" }, "standalone_applications": { "additionalProperties": false, "properties": { "incomplete": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "required": [ "can_view", "rows", "next_offset" ], "type": "object" } } }, "description": "Up to 20 rows; next_offset continues the collection.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-business-activation/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-business-activation/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-business-activation/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-business-activation/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-business-activation/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-business-activation/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Read source-scoped client progress" } }, "/businesses/{business_id}/client-intake/": { "post": { "description": "Creates or returns intake in the business's source workspace using the effective published lead source template. Works when automatic source intake is off. Preserves existing projects and Business metadata. Sends no invitation; review the intake before using its share endpoint. Requires Businesses write access.", "operationId": "createBusinessClientIntake", "parameters": [ { "in": "path", "name": "business_id", "required": true, "schema": { "pattern": "^biz_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "application_id": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" }, "business_id": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "created": { "type": "boolean" }, "frontend_link": { "format": "uri", "type": "string" } }, "required": [ "business_id", "application_id", "created", "frontend_link" ], "type": "object" } } }, "description": "Existing intake returned.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "application_id": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" }, "business_id": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "created": { "type": "boolean" }, "frontend_link": { "format": "uri", "type": "string" } }, "required": [ "business_id", "application_id", "created", "frontend_link" ], "type": "object" } } }, "description": "Intake created.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-business-client-intake/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-business-client-intake/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-business-client-intake/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-business-client-intake/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-business-client-intake/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-business-client-intake/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-business-client-intake/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Create client intake" } }, "/businesses/{business_id}/people/": { "get": { "operationId": "listBusinessPeople", "parameters": [ { "in": "path", "name": "business_id", "required": true, "schema": { "pattern": "^biz_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessPeople" } } }, "description": "Business contacts.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/list-business-people/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/list-business-people/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/list-business-people/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/list-business-people/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/list-business-people/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/list-business-people/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List Business contacts" }, "put": { "operationId": "replaceBusinessPeople", "parameters": [ { "in": "path", "name": "business_id", "required": true, "schema": { "pattern": "^biz_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "person_ids": { "items": { "pattern": "^pers_[a-z0-9]+$", "type": "string" }, "maxItems": 500, "type": "array", "uniqueItems": true }, "primary_person_id": { "anyOf": [ { "pattern": "^pers_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "person_ids" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessPeople" } } }, "description": "Updated contacts.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/replace-business-people/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/replace-business-people/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/replace-business-people/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/replace-business-people/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/replace-business-people/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/replace-business-people/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/replace-business-people/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/replace-business-people/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Replace Business contacts" } }, "/businesses/{business_id}/stage/": { "patch": { "operationId": "moveBusinessStage", "parameters": [ { "in": "path", "name": "business_id", "required": true, "schema": { "pattern": "^biz_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "stage_id": { "pattern": "^bstg_[a-z0-9]+$", "type": "string" } }, "required": [ "stage_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessStageTransition" } } }, "description": "Stage transition.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/move-business-stage/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/move-business-stage/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/move-business-stage/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/move-business-stage/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/move-business-stage/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/move-business-stage/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/move-business-stage/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/move-business-stage/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Move one Business to a workflow stage" } }, "/client-intake-application-autofill-runs/{run_id}/": { "get": { "description": "Poll the run id returned by start or retry until status is completed or failed. A completed run may still report warnings and retryable unresolved work.", "operationId": "getClientIntakeAutofillRun", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientIntakeAutofillRun" } } }, "description": "Autofill result.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-autofill-run/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-autofill-run/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-autofill-run/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-autofill-run/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-autofill-run/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-autofill-run/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-autofill-run/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-autofill-run/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Poll client intake autofill" } }, "/client-intake-application-autofill-runs/{run_id}/retry/": { "post": { "description": "Retry only unresolved work from this settled run. Completed suggestions and the frozen preparation remain unchanged; poll the same run id for the new attempt.", "operationId": "retryClientIntakeAutofill", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientIntakeAutofillRun" } } }, "description": "Autofill result.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/retry-client-intake-autofill/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/retry-client-intake-autofill/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/retry-client-intake-autofill/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/retry-client-intake-autofill/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/retry-client-intake-autofill/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/retry-client-intake-autofill/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/retry-client-intake-autofill/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/retry-client-intake-autofill/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Retry unresolved client intake autofill work" } }, "/client-intake-application-autofill-runs/{run_id}/suggestions/": { "get": { "description": "Review a cursor-paginated page of persisted proposed values and evidence. Review one pending suggestion's proposed value, evidence, and concerns. Read the current answers, then POST to the Run's suggestions_url plus {suggestion_id}/accept/ with no request body, the answer ETag in If-Match, and a unique Idempotency-Key. Levr checks the answer revision and target drift, applies the proposal, and records acceptance in one transaction. A 412 means the answers changed; reread and review before issuing a new command. A 409 suggestion_conflict means the suggestion is stale, superseded, or already resolved; refresh suggestions and review again. An identical retry must reuse the original precondition and key. Check the returned suggestion is accepted and verify the intended value through the answers read. Use the returned ETag for the next answer mutation. Do not copy proposal metadata into an answer-update request to accept a suggestion.", "operationId": "listClientIntakeAutofillSuggestions", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" } }, { "description": "Search section, question, field labels, and source excerpts.", "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Filter by one status, ignoring letter case: pending, accepted, dismissed, stale, failed.", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "Comma-separated display_order, created_at, updated_at, or status; prefix - for descending. Defaults to display_order,created_at.", "in": "query", "name": "ordering", "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientIntakeAutofillSuggestionPage" } } }, "description": "Autofill result.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-autofill-suggestions/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-autofill-suggestions/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-autofill-suggestions/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-autofill-suggestions/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-autofill-suggestions/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-autofill-suggestions/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-autofill-suggestions/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-autofill-suggestions/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List client intake autofill suggestions" } }, "/client-intake-application-autofill-runs/{run_id}/suggestions/{suggestion_id}/accept/": { "post": { "description": "Review one pending suggestion's proposed value, evidence, and concerns. Read the current answers, then POST to the Run's suggestions_url plus {suggestion_id}/accept/ with no request body, the answer ETag in If-Match, and a unique Idempotency-Key. Levr checks the answer revision and target drift, applies the proposal, and records acceptance in one transaction. A 412 means the answers changed; reread and review before issuing a new command. A 409 suggestion_conflict means the suggestion is stale, superseded, or already resolved; refresh suggestions and review again. An identical retry must reuse the original precondition and key. Check the returned suggestion is accepted and verify the intended value through the answers read. Use the returned ETag for the next answer mutation. Do not copy proposal metadata into an answer-update request to accept a suggestion.", "operationId": "acceptClientIntakeAutofillSuggestion", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" } }, { "in": "path", "name": "suggestion_id", "required": true, "schema": { "pattern": "^afsug_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "description": "The ETag returned by the current answers read.", "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientIntakeAutofillSuggestionAcceptance" } } }, "description": "The suggestion was accepted, or an identical request was replayed.", "headers": { "ETag": { "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/accept-client-intake-autofill-suggestion/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/accept-client-intake-autofill-suggestion/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/accept-client-intake-autofill-suggestion/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/accept-client-intake-autofill-suggestion/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/accept-client-intake-autofill-suggestion/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/accept-client-intake-autofill-suggestion/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/accept-client-intake-autofill-suggestion/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/accept-client-intake-autofill-suggestion/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Accept autofill suggestion" } }, "/client-intake-applications/{application_id}/": { "get": { "description": "Get lifecycle and completion status for one client-intake application. The application ID is the ciappl_ value returned by business creation or business detail.", "operationId": "getClientIntakeApplication", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientIntakeApplicationResult" } } }, "description": "The application's current status and completion progress.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-application/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-application/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-application/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-application/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-application/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Get a client intake application" } }, "/client-intake-applications/{application_id}/answers/": { "get": { "description": "Read saved answers using the question keys returned by this application's contract.", "operationId": "listClientIntakeApplicationAnswers", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "section", "schema": { "type": "string" } }, { "in": "query", "name": "search", "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 50, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientIntakeApplicationAnswerPage" } } }, "description": "A bounded page of application answers.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answers/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answers/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answers/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answers/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answers/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answers/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answers/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List client intake application answers" }, "patch": { "description": "Updates stable answers at the revision returned by the answers endpoint.", "operationId": "updateClientIntakeApplicationAnswers", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "updates": { "items": { "additionalProperties": false, "properties": { "block_key": { "description": "block_key returned by the answer read.", "maxLength": 64, "minLength": 1, "type": "string" }, "field_key": { "description": "field_key returned by the answer read.", "maxLength": 512, "minLength": 1, "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ], "description": "Replacement answer value." } }, "required": [ "block_key", "field_key", "value" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "updates" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientIntakeApplicationAnswerMutation" } } }, "description": "The committed answer update receipt.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-answers/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-answers/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-answers/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-answers/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-answers/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-answers/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-answers/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-answers/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Update client intake application answers" } }, "/client-intake-applications/{application_id}/answers/files/": { "delete": { "description": "Delete one uploaded file while preserving its repeatable row, when present.", "operationId": "deleteClientIntakeApplicationAnswerFile", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "file_id": { "pattern": "^ansfile_[a-z0-9]+$", "type": "string" } }, "required": [ "file_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-answer-file/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-answer-file/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-answer-file/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-answer-file/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-answer-file/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-answer-file/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-answer-file/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-answer-file/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-answer-file/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Delete an answer file" }, "get": { "description": "List uploaded file metadata and fresh download URLs. Optionally filter by a contract block_key or repeatable item_id.", "operationId": "listClientIntakeApplicationAnswerFiles", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "block_key", "schema": { "type": "string" } }, { "in": "query", "name": "item_id", "schema": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 50, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "items": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "download_url": { "format": "uri", "type": "string" }, "filename": { "type": "string" }, "id": { "pattern": "^ansfile_[a-z0-9]+$", "type": "string" }, "item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] }, "object": { "const": "answer_file", "type": "string" }, "size_bytes": { "minimum": 0, "type": [ "integer", "null" ] }, "uploaded_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "block_key", "item_id", "filename", "size_bytes", "uploaded_at" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "description": "Always null; this collection supports forward paging only.", "type": "null" } }, "required": [ "object", "items", "next_cursor", "previous_cursor", "answers_revision" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answer-files/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answer-files/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answer-files/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answer-files/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answer-files/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answer-files/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answer-files/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answer-files/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-answer-files/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List answer files" }, "post": { "description": "Request a one-hour upload capability for a file question. For a file inside a repeatable group, include that group's item_id.", "operationId": "createClientIntakeApplicationAnswerFileUpload", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "block_key" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expires_at": { "format": "date-time", "type": "string" }, "id": { "pattern": "^upl_.+$", "type": "string" }, "max_size_bytes": { "minimum": 1, "type": "integer" }, "multipart_field": { "const": "file", "type": "string" }, "object": { "const": "file_upload", "type": "string" }, "upload_url": { "format": "uri", "type": "string" } }, "required": [ "id", "object", "upload_url", "expires_at", "max_size_bytes", "multipart_field" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-answer-file-upload/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-answer-file-upload/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-answer-file-upload/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-answer-file-upload/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-answer-file-upload/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-answer-file-upload/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-answer-file-upload/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-answer-file-upload/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-answer-file-upload/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Request an answer-file upload" } }, "/client-intake-applications/{application_id}/answers/files/{upload_id}/": { "post": { "description": "Redeem the upload_url with exactly one multipart field named file. Use the latest answers ETag as If-Match and a unique Idempotency-Key.", "operationId": "uploadClientIntakeApplicationAnswerFile", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } }, { "in": "path", "name": "upload_id", "required": true, "schema": { "pattern": "^upl_.+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "properties": { "file": { "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-application-answer-file/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-application-answer-file/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-application-answer-file/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-application-answer-file/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-application-answer-file/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-application-answer-file/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-application-answer-file/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-application-answer-file/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-application-answer-file/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Upload an answer file" } }, "/client-intake-applications/{application_id}/answers/repeatable-items/": { "delete": { "description": "Delete one repeated row and all answers nested inside it.", "operationId": "deleteClientIntakeApplicationRepeatableItem", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" } }, "required": [ "item_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "affected_section_keys": { "items": { "type": "string" }, "type": "array" }, "answers_revision": { "minimum": 0, "type": "integer" }, "deleted_item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "item": { "additionalProperties": false, "properties": { "answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] }, "value_type": { "type": "string" } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value_type", "value" ], "type": "object" }, "type": "array" }, "block_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "order": { "minimum": 0, "type": "integer" }, "parent_item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "item_id", "block_key", "parent_item_id", "order", "answers" ], "type": "object" }, "object": { "type": "string" }, "resource": { "type": "object" }, "updated_answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "object", "resource", "answers_revision", "affected_section_keys" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-repeatable-item/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-repeatable-item/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-repeatable-item/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-repeatable-item/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-repeatable-item/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-repeatable-item/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-repeatable-item/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-repeatable-item/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/delete-client-intake-application-repeatable-item/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Delete a repeatable answer item" }, "get": { "description": "List the stable rows in one repeatable group. Pass the group's block_key from the live Application Contract.", "operationId": "listClientIntakeApplicationRepeatableItems", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "block_key", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 50, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "items": { "items": { "additionalProperties": false, "properties": { "answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] }, "value_type": { "type": "string" } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value_type", "value" ], "type": "object" }, "type": "array" }, "block_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "order": { "minimum": 0, "type": "integer" }, "parent_item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "item_id", "block_key", "parent_item_id", "order", "answers" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "description": "Always null; this collection supports forward paging only.", "type": "null" } }, "required": [ "object", "items", "next_cursor", "previous_cursor", "answers_revision" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-repeatable-items/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-repeatable-items/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-repeatable-items/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-repeatable-items/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-repeatable-items/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-repeatable-items/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-repeatable-items/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-repeatable-items/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/list-client-intake-application-repeatable-items/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List repeatable answer items" }, "patch": { "description": "Replace one or more scalar fields inside exactly one stable repeated row.", "operationId": "updateClientIntakeApplicationRepeatableItem", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "updates": { "items": { "additionalProperties": false, "properties": { "block_key": { "description": "block_key returned by the answer read.", "maxLength": 64, "minLength": 1, "type": "string" }, "field_key": { "description": "field_key returned by the answer read.", "maxLength": 512, "minLength": 1, "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ], "description": "Replacement answer value." } }, "required": [ "block_key", "field_key", "value" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "item_id", "updates" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "affected_section_keys": { "items": { "type": "string" }, "type": "array" }, "answers_revision": { "minimum": 0, "type": "integer" }, "deleted_item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "item": { "additionalProperties": false, "properties": { "answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] }, "value_type": { "type": "string" } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value_type", "value" ], "type": "object" }, "type": "array" }, "block_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "order": { "minimum": 0, "type": "integer" }, "parent_item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "item_id", "block_key", "parent_item_id", "order", "answers" ], "type": "object" }, "object": { "type": "string" }, "resource": { "type": "object" }, "updated_answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "object", "resource", "answers_revision", "affected_section_keys" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-repeatable-item/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-repeatable-item/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-repeatable-item/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-repeatable-item/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-repeatable-item/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-repeatable-item/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-repeatable-item/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-repeatable-item/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-application-repeatable-item/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Update a repeatable answer item" }, "post": { "description": "Create an empty row, then use its returned item_id for field updates or files.", "operationId": "createClientIntakeApplicationRepeatableItem", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "parent_item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "block_key" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "affected_section_keys": { "items": { "type": "string" }, "type": "array" }, "answers_revision": { "minimum": 0, "type": "integer" }, "deleted_item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "item": { "additionalProperties": false, "properties": { "answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] }, "value_type": { "type": "string" } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value_type", "value" ], "type": "object" }, "type": "array" }, "block_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "order": { "minimum": 0, "type": "integer" }, "parent_item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "item_id", "block_key", "parent_item_id", "order", "answers" ], "type": "object" }, "object": { "type": "string" }, "resource": { "type": "object" }, "updated_answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "object", "resource", "answers_revision", "affected_section_keys" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-repeatable-item/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-repeatable-item/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-repeatable-item/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-repeatable-item/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-repeatable-item/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-repeatable-item/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-repeatable-item/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-repeatable-item/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/create-client-intake-application-repeatable-item/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Create a repeatable answer item" } }, "/client-intake-applications/{application_id}/autofill-preparation/": { "get": { "description": "Read notes, the prepared-file count, selectable evidence sources, and the revision required by start.", "operationId": "getClientIntakeAutofillPreparation", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientIntakeAutofillPreparation" } } }, "description": "Current preparation.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-autofill-preparation/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-autofill-preparation/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-autofill-preparation/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-autofill-preparation/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/get-client-intake-autofill-preparation/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Read prepared client intake autofill evidence" }, "patch": { "description": "Save notes or inference mode without starting autofill. Pass the latest revision in If-Match.", "operationId": "updateClientIntakeAutofillPreparation", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientIntakeAutofillPreparationUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientIntakeAutofillPreparation" } } }, "description": "Updated preparation.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-autofill-preparation/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-autofill-preparation/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-autofill-preparation/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-autofill-preparation/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-autofill-preparation/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-autofill-preparation/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/update-client-intake-autofill-preparation/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Update client intake autofill preparation" } }, "/client-intake-applications/{application_id}/autofill-preparation/files/": { "post": { "description": "Upload one multipart file, repeat as needed, and use the latest returned preparation revision when starting autofill. If-Match prevents a stale client from silently changing the preparation.", "operationId": "uploadClientIntakeAutofillPreparationFile", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientIntakeAutofillPreparation" } } }, "description": "Updated preparation.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-autofill-preparation-file/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-autofill-preparation-file/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-autofill-preparation-file/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-autofill-preparation-file/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-autofill-preparation-file/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-autofill-preparation-file/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-autofill-preparation-file/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/upload-client-intake-autofill-preparation-file/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Upload one client intake autofill evidence file" } }, "/client-intake-applications/{application_id}/autofill-runs/": { "post": { "description": "Start asynchronous autofill from the saved notes, files, and selected evidence. Reuse the Idempotency-Key for an exact replay, then poll the returned run or subscribe to client_intake_application_autofill_run.settled.", "operationId": "startClientIntakeAutofill", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientIntakeAutofillStart" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientIntakeAutofillRun" } } }, "description": "Autofill result.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/start-client-intake-autofill/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/start-client-intake-autofill/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/start-client-intake-autofill/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/start-client-intake-autofill/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/start-client-intake-autofill/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/start-client-intake-autofill/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/start-client-intake-autofill/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/start-client-intake-autofill/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Start client intake autofill" } }, "/client-intake-applications/{application_id}/contract/": { "get": { "operationId": "retrieveClientIntakeApplicationContract", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientIntakeApplicationContract" } } }, "description": "The questions, answer types, and supported operations.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/retrieve-client-intake-application-contract/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/retrieve-client-intake-application-contract/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/retrieve-client-intake-application-contract/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/retrieve-client-intake-application-contract/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/retrieve-client-intake-application-contract/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Retrieve a client intake application contract" } }, "/client-intake-applications/{application_id}/share/": { "post": { "operationId": "shareClientIntakeApplication", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "message": { "maxLength": 5000, "type": "string" }, "recipients": { "items": { "additionalProperties": false, "properties": { "email": { "format": "email", "maxLength": 254, "type": "string" } }, "required": [ "email" ], "type": "object" }, "maxItems": 50, "minItems": 1, "type": "array" } }, "required": [ "recipients" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "delivery_state": { "const": "queued", "type": "string" }, "grants": { "items": { "additionalProperties": false, "properties": { "access_mode": { "const": "edit", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "email": { "format": "email", "type": "string" }, "expires_at": { "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "email", "access_mode", "expires_at", "created_at" ], "type": "object" }, "type": "array" }, "id": { "pattern": "^ciappl_", "type": "string" }, "object": { "const": "client_intake_application", "type": "string" } }, "required": [ "id", "object", "grants", "delivery_state" ], "type": "object" } } }, "description": "Share grants created and delivery queued.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/share-client-intake-application/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/share-client-intake-application/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/share-client-intake-application/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/share-client-intake-application/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/share-client-intake-application/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/share-client-intake-application/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/share-client-intake-application/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Share a client intake application with recipients by email" } }, "/client-intake-applications/{application_id}/submission-readiness/": { "get": { "description": "Return blocking validation issues that prevent submission.", "operationId": "checkClientIntakeApplicationSubmissionReadiness", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "blocking_issue_count": { "minimum": 0, "type": "integer" }, "has_blocking_issues": { "type": "boolean" }, "id": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" }, "issues": { "items": { "additionalProperties": false, "properties": { "attribute_label": { "type": [ "string", "null" ] }, "issue": { "type": "string" }, "message": { "type": "string" }, "request_label": { "type": [ "string", "null" ] }, "section_key": { "type": [ "string", "null" ] }, "section_label": { "type": [ "string", "null" ] }, "source": { "type": "string" } }, "required": [ "section_key", "section_label", "request_label", "attribute_label", "message", "issue", "source" ], "type": "object" }, "type": "array" }, "object": { "const": "client_intake_application", "type": "string" } }, "required": [ "id", "object", "has_blocking_issues", "blocking_issue_count", "issues" ], "type": "object" } } }, "description": "Readiness summary with any blocking issues.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/check-client-intake-application-submission-readiness/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/check-client-intake-application-submission-readiness/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/check-client-intake-application-submission-readiness/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/check-client-intake-application-submission-readiness/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/check-client-intake-application-submission-readiness/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/check-client-intake-application-submission-readiness/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Check client intake application submission readiness" } }, "/client-intake-applications/{application_id}/submit/": { "post": { "description": "Validates and submits the application at its current lifecycle revision.", "operationId": "submitClientIntakeApplication", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_answers_revision": { "minimum": 0, "type": "integer" } }, "required": [ "expected_answers_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientIntakeApplicationResult" } } }, "description": "The submitted application and its committed lifecycle revision.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/submit-client-intake-application/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/submit-client-intake-application/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/submit-client-intake-application/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/submit-client-intake-application/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/submit-client-intake-application/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/submit-client-intake-application/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/submit-client-intake-application/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/client-intake-applications/submit-client-intake-application/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Submit a client intake application" } }, "/deal-application-autofill-runs/{run_id}/": { "get": { "description": "Poll the run id returned by start or retry until status is completed or failed. A completed run may still report warnings and retryable work.", "operationId": "getDealApplicationAutofillRun", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealApplicationAutofillRun" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-run/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-run/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-run/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-run/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-run/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-run/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-run/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-run/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Get a Deal Application autofill run" } }, "/deal-application-autofill-runs/{run_id}/retry/": { "post": { "description": "Retry only unresolved work from this settled run. Completed suggestions and the frozen preparation remain unchanged; poll the same run id for the new attempt.", "operationId": "retryDealApplicationAutofill", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealApplicationAutofillRun" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retry-deal-application-autofill/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retry-deal-application-autofill/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retry-deal-application-autofill/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retry-deal-application-autofill/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retry-deal-application-autofill/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retry-deal-application-autofill/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retry-deal-application-autofill/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retry-deal-application-autofill/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Retry Deal Application autofill" } }, "/deal-application-autofill-runs/{run_id}/suggestions/": { "get": { "description": "Review a cursor-paginated page of persisted proposed values and evidence. Review one pending suggestion's proposed value, evidence, and concerns. Read the current answers, then POST to the Run's suggestions_url plus {suggestion_id}/accept/ with no request body, the answer ETag in If-Match, and a unique Idempotency-Key. Levr checks the answer revision and target drift, applies the proposal, and records acceptance in one transaction. A 412 means the answers changed; reread and review before issuing a new command. A 409 suggestion_conflict means the suggestion is stale, superseded, or already resolved; refresh suggestions and review again. An identical retry must reuse the original precondition and key. Check the returned suggestion is accepted and verify the intended value through the answers read. Use the returned ETag for the next answer mutation. Do not copy proposal metadata into an answer-update request to accept a suggestion.", "operationId": "listDealApplicationAutofillSuggestions", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" } }, { "description": "Search section, question, field labels, and source excerpts.", "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Filter by one status, ignoring letter case: pending, accepted, dismissed, stale, failed.", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "Comma-separated display_order, created_at, updated_at, or status; prefix - for descending. Defaults to display_order,created_at.", "in": "query", "name": "ordering", "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealApplicationAutofillSuggestionPage" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-autofill-suggestions/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-autofill-suggestions/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-autofill-suggestions/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-autofill-suggestions/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-autofill-suggestions/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-autofill-suggestions/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-autofill-suggestions/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-autofill-suggestions/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List Deal Application autofill suggestions" } }, "/deal-application-autofill-runs/{run_id}/suggestions/{suggestion_id}/accept/": { "post": { "description": "Review one pending suggestion's proposed value, evidence, and concerns. Read the current answers, then POST to the Run's suggestions_url plus {suggestion_id}/accept/ with no request body, the answer ETag in If-Match, and a unique Idempotency-Key. Levr checks the answer revision and target drift, applies the proposal, and records acceptance in one transaction. A 412 means the answers changed; reread and review before issuing a new command. A 409 suggestion_conflict means the suggestion is stale, superseded, or already resolved; refresh suggestions and review again. An identical retry must reuse the original precondition and key. Check the returned suggestion is accepted and verify the intended value through the answers read. Use the returned ETag for the next answer mutation. Do not copy proposal metadata into an answer-update request to accept a suggestion.", "operationId": "acceptDealApplicationAutofillSuggestion", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" } }, { "in": "path", "name": "suggestion_id", "required": true, "schema": { "pattern": "^afsug_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "description": "The ETag returned by the current answers read.", "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealApplicationAutofillSuggestionAcceptance" } } }, "description": "The suggestion was accepted, or an identical request was replayed.", "headers": { "ETag": { "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/accept-deal-application-autofill-suggestion/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/accept-deal-application-autofill-suggestion/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/accept-deal-application-autofill-suggestion/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/accept-deal-application-autofill-suggestion/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/accept-deal-application-autofill-suggestion/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/accept-deal-application-autofill-suggestion/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/accept-deal-application-autofill-suggestion/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/accept-deal-application-autofill-suggestion/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Accept autofill suggestion" } }, "/deal-applications/{application_id}/": { "get": { "operationId": "retrieveDealApplication", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealApplication" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Retrieve a Deal Application" } }, "/deal-applications/{application_id}/answers/": { "get": { "operationId": "listDealApplicationAnswers", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "section", "schema": { "type": "string" } }, { "in": "query", "name": "search", "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 50, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealApplicationAnswerPage" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answers/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answers/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answers/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answers/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answers/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answers/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answers/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answers/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List Deal Application answers" }, "patch": { "operationId": "updateDealApplicationAnswers", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "updates": { "items": { "additionalProperties": false, "properties": { "block_key": { "description": "block_key returned by the answer read.", "maxLength": 64, "minLength": 1, "type": "string" }, "field_key": { "description": "field_key returned by the answer read.", "maxLength": 512, "minLength": 1, "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ], "description": "Replacement answer value." } }, "required": [ "block_key", "field_key", "value" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "updates" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealApplicationAnswerMutation" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-answers/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-answers/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-answers/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-answers/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-answers/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-answers/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-answers/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-answers/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Update Deal Application answers" } }, "/deal-applications/{application_id}/answers/files/": { "delete": { "description": "Delete one uploaded file while preserving its repeatable row, when present.", "operationId": "deleteDealApplicationAnswerFile", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "file_id": { "pattern": "^ansfile_[a-z0-9]+$", "type": "string" } }, "required": [ "file_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-answer-file/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-answer-file/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-answer-file/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-answer-file/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-answer-file/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-answer-file/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-answer-file/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-answer-file/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-answer-file/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Delete an answer file" }, "get": { "description": "List uploaded file metadata and fresh download URLs. Optionally filter by a contract block_key or repeatable item_id.", "operationId": "listDealApplicationAnswerFiles", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "block_key", "schema": { "type": "string" } }, { "in": "query", "name": "item_id", "schema": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 50, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "items": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "download_url": { "format": "uri", "type": "string" }, "filename": { "type": "string" }, "id": { "pattern": "^ansfile_[a-z0-9]+$", "type": "string" }, "item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] }, "object": { "const": "answer_file", "type": "string" }, "size_bytes": { "minimum": 0, "type": [ "integer", "null" ] }, "uploaded_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "block_key", "item_id", "filename", "size_bytes", "uploaded_at" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "description": "Always null; this collection supports forward paging only.", "type": "null" } }, "required": [ "object", "items", "next_cursor", "previous_cursor", "answers_revision" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answer-files/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answer-files/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answer-files/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answer-files/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answer-files/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answer-files/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answer-files/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answer-files/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-answer-files/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List answer files" }, "post": { "description": "Request a one-hour upload capability for a file question. For a file inside a repeatable group, include that group's item_id.", "operationId": "createDealApplicationAnswerFileUpload", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "block_key" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expires_at": { "format": "date-time", "type": "string" }, "id": { "pattern": "^upl_.+$", "type": "string" }, "max_size_bytes": { "minimum": 1, "type": "integer" }, "multipart_field": { "const": "file", "type": "string" }, "object": { "const": "file_upload", "type": "string" }, "upload_url": { "format": "uri", "type": "string" } }, "required": [ "id", "object", "upload_url", "expires_at", "max_size_bytes", "multipart_field" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-answer-file-upload/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-answer-file-upload/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-answer-file-upload/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-answer-file-upload/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-answer-file-upload/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-answer-file-upload/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-answer-file-upload/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-answer-file-upload/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-answer-file-upload/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Request an answer-file upload" } }, "/deal-applications/{application_id}/answers/files/{upload_id}/": { "post": { "description": "Redeem the upload_url with exactly one multipart field named file. Use the latest answers ETag as If-Match and a unique Idempotency-Key.", "operationId": "uploadDealApplicationAnswerFile", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "path", "name": "upload_id", "required": true, "schema": { "pattern": "^upl_.+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "properties": { "file": { "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-answer-file/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-answer-file/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-answer-file/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-answer-file/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-answer-file/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-answer-file/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-answer-file/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-answer-file/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-answer-file/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Upload an answer file" } }, "/deal-applications/{application_id}/answers/repeatable-items/": { "delete": { "description": "Delete one repeated row and all answers nested inside it.", "operationId": "deleteDealApplicationRepeatableItem", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" } }, "required": [ "item_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "affected_section_keys": { "items": { "type": "string" }, "type": "array" }, "answers_revision": { "minimum": 0, "type": "integer" }, "deleted_item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "item": { "additionalProperties": false, "properties": { "answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] }, "value_type": { "type": "string" } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value_type", "value" ], "type": "object" }, "type": "array" }, "block_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "order": { "minimum": 0, "type": "integer" }, "parent_item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "item_id", "block_key", "parent_item_id", "order", "answers" ], "type": "object" }, "object": { "type": "string" }, "resource": { "type": "object" }, "updated_answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "object", "resource", "answers_revision", "affected_section_keys" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-repeatable-item/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-repeatable-item/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-repeatable-item/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-repeatable-item/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-repeatable-item/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-repeatable-item/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-repeatable-item/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-repeatable-item/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/delete-deal-application-repeatable-item/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Delete a repeatable answer item" }, "get": { "description": "List the stable rows in one repeatable group. Pass the group's block_key from the live Application Contract.", "operationId": "listDealApplicationRepeatableItems", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "block_key", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 50, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "items": { "items": { "additionalProperties": false, "properties": { "answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] }, "value_type": { "type": "string" } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value_type", "value" ], "type": "object" }, "type": "array" }, "block_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "order": { "minimum": 0, "type": "integer" }, "parent_item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "item_id", "block_key", "parent_item_id", "order", "answers" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "description": "Always null; this collection supports forward paging only.", "type": "null" } }, "required": [ "object", "items", "next_cursor", "previous_cursor", "answers_revision" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-repeatable-items/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-repeatable-items/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-repeatable-items/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-repeatable-items/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-repeatable-items/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-repeatable-items/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-repeatable-items/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-repeatable-items/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/list-deal-application-repeatable-items/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List repeatable answer items" }, "patch": { "description": "Replace one or more scalar fields inside exactly one stable repeated row.", "operationId": "updateDealApplicationRepeatableItem", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "updates": { "items": { "additionalProperties": false, "properties": { "block_key": { "description": "block_key returned by the answer read.", "maxLength": 64, "minLength": 1, "type": "string" }, "field_key": { "description": "field_key returned by the answer read.", "maxLength": 512, "minLength": 1, "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ], "description": "Replacement answer value." } }, "required": [ "block_key", "field_key", "value" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "item_id", "updates" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "affected_section_keys": { "items": { "type": "string" }, "type": "array" }, "answers_revision": { "minimum": 0, "type": "integer" }, "deleted_item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "item": { "additionalProperties": false, "properties": { "answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] }, "value_type": { "type": "string" } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value_type", "value" ], "type": "object" }, "type": "array" }, "block_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "order": { "minimum": 0, "type": "integer" }, "parent_item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "item_id", "block_key", "parent_item_id", "order", "answers" ], "type": "object" }, "object": { "type": "string" }, "resource": { "type": "object" }, "updated_answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "object", "resource", "answers_revision", "affected_section_keys" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-repeatable-item/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-repeatable-item/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-repeatable-item/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-repeatable-item/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-repeatable-item/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-repeatable-item/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-repeatable-item/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-repeatable-item/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-repeatable-item/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Update a repeatable answer item" }, "post": { "description": "Create an empty row, then use its returned item_id for field updates or files.", "operationId": "createDealApplicationRepeatableItem", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "parent_item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "block_key" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "affected_section_keys": { "items": { "type": "string" }, "type": "array" }, "answers_revision": { "minimum": 0, "type": "integer" }, "deleted_item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "item": { "additionalProperties": false, "properties": { "answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] }, "value_type": { "type": "string" } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value_type", "value" ], "type": "object" }, "type": "array" }, "block_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "order": { "minimum": 0, "type": "integer" }, "parent_item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "item_id", "block_key", "parent_item_id", "order", "answers" ], "type": "object" }, "object": { "type": "string" }, "resource": { "type": "object" }, "updated_answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "object", "resource", "answers_revision", "affected_section_keys" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-repeatable-item/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-repeatable-item/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-repeatable-item/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-repeatable-item/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-repeatable-item/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-repeatable-item/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-repeatable-item/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-repeatable-item/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/create-deal-application-repeatable-item/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Create a repeatable answer item" } }, "/deal-applications/{application_id}/autofill-preparation/": { "get": { "description": "Read the saved notes, prepared-file count, evidence choices, mode, and revision. This does not upload files or start inference.", "operationId": "getDealApplicationAutofillPreparation", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealApplicationAutofillPreparation" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-preparation/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-preparation/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-preparation/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-preparation/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-preparation/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-preparation/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-preparation/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-autofill-preparation/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Get Deal Application autofill preparation" }, "patch": { "description": "Save notes or inference mode without starting autofill. Pass the latest preparation ETag in If-Match; an outdated revision fails safely.", "operationId": "updateDealApplicationAutofillPreparation", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "minProperties": 1, "properties": { "ai_mode": { "enum": [ "fast", "thinking" ], "type": "string" }, "text_input": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealApplicationAutofillPreparation" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-autofill-preparation/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-autofill-preparation/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-autofill-preparation/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-autofill-preparation/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-autofill-preparation/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-autofill-preparation/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-autofill-preparation/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/update-deal-application-autofill-preparation/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Update Deal Application autofill preparation" } }, "/deal-applications/{application_id}/autofill-preparation/files/": { "post": { "description": "Upload one multipart file, repeat as needed, and use the latest returned preparation revision when starting autofill. If-Match prevents a stale client from silently changing the preparation.", "operationId": "uploadDealApplicationAutofillPreparationFile", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealApplicationAutofillPreparation" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-autofill-preparation-file/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-autofill-preparation-file/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-autofill-preparation-file/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-autofill-preparation-file/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-autofill-preparation-file/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-autofill-preparation-file/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-autofill-preparation-file/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/upload-deal-application-autofill-preparation-file/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Upload a Deal Application autofill preparation file" } }, "/deal-applications/{application_id}/autofill-runs/": { "post": { "description": "Start asynchronous autofill from the saved preparation. Reuse the Idempotency-Key for an exact replay, then poll the returned run or subscribe to deal_application_autofill_run.settled.", "operationId": "startDealApplicationAutofill", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "ai_mode": { "enum": [ "fast", "thinking" ], "type": "string" }, "expected_preparation_revision": { "minimum": 1, "type": "integer" }, "selected_evidence_source_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "expected_preparation_revision" ], "type": "object" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealApplicationAutofillRun" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/start-deal-application-autofill/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/start-deal-application-autofill/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/start-deal-application-autofill/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/start-deal-application-autofill/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/start-deal-application-autofill/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/start-deal-application-autofill/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/start-deal-application-autofill/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/start-deal-application-autofill/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Start Deal Application autofill" } }, "/deal-applications/{application_id}/contract/": { "get": { "operationId": "retrieveDealApplicationContract", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealApplicationContract" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application-contract/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application-contract/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application-contract/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application-contract/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application-contract/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application-contract/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application-contract/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/retrieve-deal-application-contract/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Retrieve a Deal Application contract" } }, "/deal-applications/{application_id}/decision-options/": { "get": { "description": "Read the decisions available to your Portal and current optional notification recipients. Requires deal_applications write access and a Deal in your Portal. Availability follows your role on the Deal and its current application status. The returned ETag identifies the application revision; answers_revision identifies the reviewed answers.", "operationId": "getDealApplicationDecisionOptions", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealApplicationDecisionOptions" } } }, "description": "Successful response.", "headers": { "ETag": { "description": "Application lifecycle revision.", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-decision-options/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-decision-options/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-decision-options/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-decision-options/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-decision-options/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-decision-options/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-decision-options/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/get-deal-application-decision-options/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List available Deal application decisions" } }, "/deal-applications/{application_id}/decline/": { "post": { "description": "Read decision options first. Send the application ETag in If-Match, its answers_revision as expected_answers_revision, and a new Idempotency-Key. Copy only email and origin for each selected recipient from the returned list; [] sends no optional communications. Shared status, history, stage synchronization, automatic notifications and configured stage email automations still apply. Identical retries return the original result. An optional destination_stage_id must be in your Deal's pipeline and match the resulting application status. If omitted, the Deal uses your Portal's matching outcome stage, creating the default stage when needed; other Portals follow their synchronization preferences.", "operationId": "declineDealApplication", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "destination_stage_id": { "pattern": "^dstg_[a-z0-9]+$", "type": "string" }, "expected_answers_revision": { "minimum": 0, "type": "integer" }, "internal_reason": { "description": "Reason recorded in application status history; it is not the recipient message.", "example": "Outside our lending criteria.", "maxLength": 10000, "type": "string" }, "message": { "example": "We have updated the outcome of your funding request.", "maxLength": 10000, "type": "string" }, "recipients": { "items": { "additionalProperties": false, "properties": { "email": { "example": "broker@example.com", "format": "email", "maxLength": 254, "type": "string" }, "origin": { "enum": [ "organization", "source_provider", "processing_provider" ], "type": "string" } }, "required": [ "email", "origin" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "expected_answers_revision", "recipients" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "answers_revision": 7, "id": "dapp_7fj3k9m2d8q4n6wx", "object": "deal_application", "revision": 4, "status": "is_declined" }, "schema": { "$ref": "#/components/schemas/DealApplicationDecision" } } }, "description": "Successful response.", "headers": { "ETag": { "description": "Application lifecycle revision.", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/decline-deal-application/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/decline-deal-application/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/decline-deal-application/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/decline-deal-application/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/decline-deal-application/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/decline-deal-application/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/decline-deal-application/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/decline-deal-application/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Decline a Deal application" } }, "/deal-applications/{application_id}/fund/": { "post": { "description": "Read decision options first. Send the application ETag in If-Match, its answers_revision as expected_answers_revision, and a new Idempotency-Key. Copy only email and origin for each selected recipient from the returned list; [] sends no optional communications. Shared status, history, stage synchronization, automatic notifications and configured stage email automations still apply. Identical retries return the original result. An optional destination_stage_id must be in your Deal's pipeline and match the resulting application status. If omitted, the Deal uses your Portal's matching outcome stage, creating the default stage when needed; other Portals follow their synchronization preferences. Complete the financing fields required by your Portal's pipeline first. If funding is confirmed before you have the funded amount, set allow_missing_funded_amount to true; it defaults to false. Other required fields and invalid amounts still block the action. Add the funded amount later through Update Deal financing terms. Recording funding may create commission obligations; it does not transfer funds.", "operationId": "fundDealApplication", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "allow_missing_funded_amount": { "default": false, "description": "Allow funding to be recorded before the funded amount is known. Only a missing funded amount is allowed; other required fields and invalid values are still checked.", "example": false, "type": "boolean" }, "destination_stage_id": { "pattern": "^dstg_[a-z0-9]+$", "type": "string" }, "expected_answers_revision": { "minimum": 0, "type": "integer" }, "message": { "example": "We have updated the outcome of your funding request.", "maxLength": 10000, "type": "string" }, "recipients": { "items": { "additionalProperties": false, "properties": { "email": { "example": "broker@example.com", "format": "email", "maxLength": 254, "type": "string" }, "origin": { "enum": [ "organization", "source_provider", "processing_provider" ], "type": "string" } }, "required": [ "email", "origin" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "expected_answers_revision", "recipients" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "answers_revision": 7, "id": "dapp_7fj3k9m2d8q4n6wx", "object": "deal_application", "revision": 4, "status": "is_disbursed" }, "schema": { "$ref": "#/components/schemas/DealApplicationDecision" } } }, "description": "Successful response.", "headers": { "ETag": { "description": "Application lifecycle revision.", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/fund-deal-application/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/fund-deal-application/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/fund-deal-application/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/fund-deal-application/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/fund-deal-application/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/fund-deal-application/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/fund-deal-application/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/fund-deal-application/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Mark a Deal application funded" } }, "/deal-applications/{application_id}/mark-not-submitted/": { "post": { "description": "Read decision options first. Send the application ETag in If-Match, its answers_revision as expected_answers_revision, and a new Idempotency-Key. Copy only email and origin for each selected recipient from the returned list; [] sends no optional communications. Shared status, history, stage synchronization, automatic notifications and configured stage email automations still apply. Identical retries return the original result. An optional destination_stage_id must be in your Deal's pipeline and match the resulting application status. If omitted, the Deal uses your Portal's matching outcome stage, creating the default stage when needed; other Portals follow their synchronization preferences. Available only before an actual submission; it does not undo submission.", "operationId": "markNotSubmittedDealApplication", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "destination_stage_id": { "pattern": "^dstg_[a-z0-9]+$", "type": "string" }, "expected_answers_revision": { "minimum": 0, "type": "integer" }, "message": { "example": "We have updated the outcome of your funding request.", "maxLength": 10000, "type": "string" }, "recipients": { "items": { "additionalProperties": false, "properties": { "email": { "example": "broker@example.com", "format": "email", "maxLength": 254, "type": "string" }, "origin": { "enum": [ "organization", "source_provider", "processing_provider" ], "type": "string" } }, "required": [ "email", "origin" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "expected_answers_revision", "recipients" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "answers_revision": 7, "id": "dapp_7fj3k9m2d8q4n6wx", "object": "deal_application", "revision": 4, "status": "is_pre_submitted" }, "schema": { "$ref": "#/components/schemas/DealApplicationDecision" } } }, "description": "Successful response.", "headers": { "ETag": { "description": "Application lifecycle revision.", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-not-submitted-deal-application/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-not-submitted-deal-application/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-not-submitted-deal-application/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-not-submitted-deal-application/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-not-submitted-deal-application/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-not-submitted-deal-application/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-not-submitted-deal-application/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-not-submitted-deal-application/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Record a Deal application as not submitted" } }, "/deal-applications/{application_id}/mark-submitted/": { "post": { "description": "Read decision options first. Send the application ETag in If-Match, its answers_revision as expected_answers_revision, and a new Idempotency-Key. Copy only email and origin for each selected recipient from the returned list; [] sends no optional communications. Shared status, history, stage synchronization, automatic notifications and configured stage email automations still apply. Identical retries return the original result. An optional destination_stage_id must be in your Deal's pipeline and match the resulting application status. If omitted, the Deal uses your Portal's matching outcome stage, creating the default stage when needed; other Portals follow their synchronization preferences. This records submitted status without delivering the application or changing submission history. Use submit for actual submission. Reopen applies to declined, withdrawn, timed-out or funded applications; mark-submitted records submitted status whenever that action is available.", "operationId": "markSubmittedDealApplication", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "destination_stage_id": { "pattern": "^dstg_[a-z0-9]+$", "type": "string" }, "expected_answers_revision": { "minimum": 0, "type": "integer" }, "message": { "example": "We have updated the outcome of your funding request.", "maxLength": 10000, "type": "string" }, "note_text": { "description": "Adds a note to the Deal in your Portal.", "example": "Reopened for further review.", "maxLength": 10000, "type": "string" }, "recipients": { "items": { "additionalProperties": false, "properties": { "email": { "example": "broker@example.com", "format": "email", "maxLength": 254, "type": "string" }, "origin": { "enum": [ "organization", "source_provider", "processing_provider" ], "type": "string" } }, "required": [ "email", "origin" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "expected_answers_revision", "recipients" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "answers_revision": 7, "id": "dapp_7fj3k9m2d8q4n6wx", "object": "deal_application", "revision": 4, "status": "is_submitted_to_processor" }, "schema": { "$ref": "#/components/schemas/DealApplicationDecision" } } }, "description": "Successful response.", "headers": { "ETag": { "description": "Application lifecycle revision.", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-submitted-deal-application/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-submitted-deal-application/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-submitted-deal-application/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-submitted-deal-application/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-submitted-deal-application/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-submitted-deal-application/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-submitted-deal-application/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/mark-submitted-deal-application/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Record a Deal application as submitted" } }, "/deal-applications/{application_id}/reopen/": { "post": { "description": "Read decision options first. Send the application ETag in If-Match, its answers_revision as expected_answers_revision, and a new Idempotency-Key. Copy only email and origin for each selected recipient from the returned list; [] sends no optional communications. Shared status, history, stage synchronization, automatic notifications and configured stage email automations still apply. Identical retries return the original result. An optional destination_stage_id must be in your Deal's pipeline and match the resulting application status. If omitted, the Deal uses your Portal's matching outcome stage, creating the default stage when needed; other Portals follow their synchronization preferences. This records submitted status without delivering the application or changing submission history. Use submit for actual submission. Reopen applies to declined, withdrawn, timed-out or funded applications; mark-submitted records submitted status whenever that action is available.", "operationId": "reopenDealApplication", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "destination_stage_id": { "pattern": "^dstg_[a-z0-9]+$", "type": "string" }, "expected_answers_revision": { "minimum": 0, "type": "integer" }, "message": { "example": "We have updated the outcome of your funding request.", "maxLength": 10000, "type": "string" }, "note_text": { "description": "Adds a note to the Deal in your Portal.", "example": "Reopened for further review.", "maxLength": 10000, "type": "string" }, "recipients": { "items": { "additionalProperties": false, "properties": { "email": { "example": "broker@example.com", "format": "email", "maxLength": 254, "type": "string" }, "origin": { "enum": [ "organization", "source_provider", "processing_provider" ], "type": "string" } }, "required": [ "email", "origin" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "expected_answers_revision", "recipients" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "answers_revision": 7, "id": "dapp_7fj3k9m2d8q4n6wx", "object": "deal_application", "revision": 4, "status": "is_submitted_to_processor" }, "schema": { "$ref": "#/components/schemas/DealApplicationDecision" } } }, "description": "Successful response.", "headers": { "ETag": { "description": "Application lifecycle revision.", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/reopen-deal-application/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/reopen-deal-application/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/reopen-deal-application/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/reopen-deal-application/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/reopen-deal-application/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/reopen-deal-application/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/reopen-deal-application/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/reopen-deal-application/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Reopen a Deal application" } }, "/deal-applications/{application_id}/share/": { "post": { "operationId": "shareDealApplication", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "message": { "maxLength": 5000, "type": "string" }, "recipients": { "items": { "additionalProperties": false, "properties": { "email": { "format": "email", "maxLength": 254, "type": "string" } }, "required": [ "email" ], "type": "object" }, "maxItems": 50, "minItems": 1, "type": "array" } }, "required": [ "recipients" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "delivery_state": { "const": "queued", "type": "string" }, "grants": { "items": { "additionalProperties": false, "properties": { "access_mode": { "const": "view_only", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "email": { "format": "email", "type": "string" }, "expires_at": { "format": "date-time", "type": [ "string", "null" ] } }, "required": [ "email", "access_mode", "expires_at", "created_at" ], "type": "object" }, "type": "array" }, "id": { "pattern": "^dapp_", "type": "string" }, "object": { "const": "deal_application", "type": "string" } }, "required": [ "id", "object", "grants", "delivery_state" ], "type": "object" } } }, "description": "Share grants created and delivery queued.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/share-deal-application/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/share-deal-application/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/share-deal-application/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/share-deal-application/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/share-deal-application/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/share-deal-application/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/share-deal-application/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Share a Deal Application with recipients by email" } }, "/deal-applications/{application_id}/submission-readiness/": { "get": { "description": "Return blocking validation issues that prevent submission.", "operationId": "checkDealApplicationSubmissionReadiness", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "blocking_issue_count": { "minimum": 0, "type": "integer" }, "has_blocking_issues": { "type": "boolean" }, "id": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "issues": { "items": { "additionalProperties": false, "properties": { "attribute_label": { "type": [ "string", "null" ] }, "issue": { "type": "string" }, "message": { "type": "string" }, "request_label": { "type": [ "string", "null" ] }, "section_key": { "type": [ "string", "null" ] }, "section_label": { "type": [ "string", "null" ] }, "source": { "type": "string" } }, "required": [ "section_key", "section_label", "request_label", "attribute_label", "message", "issue", "source" ], "type": "object" }, "type": "array" }, "object": { "const": "deal_application", "type": "string" } }, "required": [ "id", "object", "has_blocking_issues", "blocking_issue_count", "issues" ], "type": "object" } } }, "description": "Readiness summary with any blocking issues.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/check-deal-application-submission-readiness/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/check-deal-application-submission-readiness/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/check-deal-application-submission-readiness/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/check-deal-application-submission-readiness/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/check-deal-application-submission-readiness/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/check-deal-application-submission-readiness/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Check Deal Application submission readiness" } }, "/deal-applications/{application_id}/submit/": { "post": { "operationId": "submitDealApplication", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_answers_revision": { "minimum": 0, "type": "integer" } }, "required": [ "expected_answers_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealApplication" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/submit-deal-application/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/submit-deal-application/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/submit-deal-application/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/submit-deal-application/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/submit-deal-application/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/submit-deal-application/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/submit-deal-application/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/submit-deal-application/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Submit a Deal Application" } }, "/deal-applications/{application_id}/timeout/": { "post": { "description": "Read decision options first. Send the application ETag in If-Match, its answers_revision as expected_answers_revision, and a new Idempotency-Key. Copy only email and origin for each selected recipient from the returned list; [] sends no optional communications. Shared status, history, stage synchronization, automatic notifications and configured stage email automations still apply. Identical retries return the original result. An optional destination_stage_id must be in your Deal's pipeline and match the resulting application status. If omitted, the Deal uses your Portal's matching outcome stage, creating the default stage when needed; other Portals follow their synchronization preferences.", "operationId": "timeoutDealApplication", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "destination_stage_id": { "pattern": "^dstg_[a-z0-9]+$", "type": "string" }, "expected_answers_revision": { "minimum": 0, "type": "integer" }, "internal_reason": { "description": "Reason recorded in application status history; it is not the recipient message.", "example": "Outside our lending criteria.", "maxLength": 10000, "type": "string" }, "message": { "example": "We have updated the outcome of your funding request.", "maxLength": 10000, "type": "string" }, "recipients": { "items": { "additionalProperties": false, "properties": { "email": { "example": "broker@example.com", "format": "email", "maxLength": 254, "type": "string" }, "origin": { "enum": [ "organization", "source_provider", "processing_provider" ], "type": "string" } }, "required": [ "email", "origin" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "expected_answers_revision", "recipients" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "answers_revision": 7, "id": "dapp_7fj3k9m2d8q4n6wx", "object": "deal_application", "revision": 4, "status": "is_timed_out" }, "schema": { "$ref": "#/components/schemas/DealApplicationDecision" } } }, "description": "Successful response.", "headers": { "ETag": { "description": "Application lifecycle revision.", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/timeout-deal-application/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/timeout-deal-application/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/timeout-deal-application/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/timeout-deal-application/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/timeout-deal-application/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/timeout-deal-application/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/timeout-deal-application/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/timeout-deal-application/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Mark a Deal application timed out" } }, "/deal-applications/{application_id}/withdraw/": { "post": { "description": "Read decision options first. Send the application ETag in If-Match, its answers_revision as expected_answers_revision, and a new Idempotency-Key. Copy only email and origin for each selected recipient from the returned list; [] sends no optional communications. Shared status, history, stage synchronization, automatic notifications and configured stage email automations still apply. Identical retries return the original result. An optional destination_stage_id must be in your Deal's pipeline and match the resulting application status. If omitted, the Deal uses your Portal's matching outcome stage, creating the default stage when needed; other Portals follow their synchronization preferences.", "operationId": "withdrawDealApplication", "parameters": [ { "in": "path", "name": "application_id", "required": true, "schema": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "destination_stage_id": { "pattern": "^dstg_[a-z0-9]+$", "type": "string" }, "expected_answers_revision": { "minimum": 0, "type": "integer" }, "message": { "example": "We have updated the outcome of your funding request.", "maxLength": 10000, "type": "string" }, "recipients": { "items": { "additionalProperties": false, "properties": { "email": { "example": "broker@example.com", "format": "email", "maxLength": 254, "type": "string" }, "origin": { "enum": [ "organization", "source_provider", "processing_provider" ], "type": "string" } }, "required": [ "email", "origin" ], "type": "object" }, "maxItems": 100, "type": "array" } }, "required": [ "expected_answers_revision", "recipients" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "answers_revision": 7, "id": "dapp_7fj3k9m2d8q4n6wx", "object": "deal_application", "revision": 4, "status": "is_withdrawn" }, "schema": { "$ref": "#/components/schemas/DealApplicationDecision" } } }, "description": "Successful response.", "headers": { "ETag": { "description": "Application lifecycle revision.", "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/withdraw-deal-application/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/withdraw-deal-application/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/withdraw-deal-application/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/withdraw-deal-application/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/withdraw-deal-application/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/withdraw-deal-application/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/withdraw-deal-application/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-applications/withdraw-deal-application/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Withdraw a Deal application" } }, "/deal-pipelines/{pipeline_slug}/stages/": { "get": { "operationId": "getDealStageConfiguration", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "example": { "categories": [ { "description": "Linked application status: Pre-submitted. Existing status updates and notifications still apply.", "key": "is_pre_submitted", "label": "Pre-submitted" } ], "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "stages": [ { "category_key": "is_pre_submitted", "category_label": "Pre-submitted", "deletion_blocker": "Move the records in this stage before removing it.", "id": "dstg_a1b2c3d4e5f6g7h8", "name": "Preparing application", "object": "deal_stage", "record_count": 3 } ] }, "properties": { "categories": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "key": { "type": "string" }, "label": { "type": "string" } }, "required": [ "key", "label", "description" ], "type": "object" }, "type": "array" }, "revision": { "type": "string" }, "stages": { "items": { "additionalProperties": false, "properties": { "category_key": { "maxLength": 100, "type": "string" }, "category_label": { "type": "string" }, "deletion_blocker": { "description": "Why this stage must remain in the workflow, or null when it can be removed.", "type": [ "string", "null" ] }, "id": { "pattern": "^dstg_[a-z0-9]+$", "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "object": { "const": "deal_stage", "type": "string" }, "record_count": { "description": "Records referencing this stage, including records excluded from API collections. Used for stage removal checks; not a collection total.", "type": "integer" } }, "required": [ "id", "object", "name", "category_key", "category_label", "record_count", "deletion_blocker" ], "type": "object" }, "type": "array" } }, "required": [ "revision", "categories", "stages" ], "type": "object" } } }, "description": "Current provider workflows", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-pipelines/get-deal-stage-configuration/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-pipelines/get-deal-stage-configuration/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-pipelines/get-deal-stage-configuration/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-pipelines/get-deal-stage-configuration/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-pipelines/get-deal-stage-configuration/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-pipelines/get-deal-stage-configuration/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-pipelines/get-deal-stage-configuration/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Read deal stages" }, "parameters": [ { "in": "path", "name": "pipeline_slug", "required": true, "schema": { "pattern": "^dpipe_[a-z0-9]+$", "type": "string" } } ], "put": { "description": "Read first. Send the complete desired stage list and that workflow's expected_revision. Existing categories cannot change. Follow the stage creation fields in this resource schema. Omit a stage only when its deletion_blocker is null. Records are never moved by a configuration edit. Reuse Idempotency-Key only for an identical retry.", "operationId": "updateDealStageConfiguration", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "example": { "expected_revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "stages": [ { "category_key": "is_pre_submitted", "id": "dstg_a1b2c3d4e5f6g7h8", "name": "Preparing application" }, { "category_key": "is_pre_submitted", "copy_from_id": "dstg_a1b2c3d4e5f6g7h8", "name": "Waiting for documents" } ] }, "properties": { "expected_revision": { "maxLength": 64, "minLength": 64, "type": "string" }, "stages": { "items": { "additionalProperties": false, "properties": { "category_key": { "maxLength": 100, "type": "string" }, "copy_from_id": { "description": "Required for a new stage. Copy a stage from this deal pipeline with the same category_key to preserve application automation.", "pattern": "^dstg_[a-z0-9]+$", "type": "string" }, "id": { "pattern": "^dstg_[a-z0-9]+$", "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "name", "category_key" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "expected_revision", "stages" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "example": { "categories": [ { "description": "Linked application status: Pre-submitted. Existing status updates and notifications still apply.", "key": "is_pre_submitted", "label": "Pre-submitted" } ], "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "stages": [ { "category_key": "is_pre_submitted", "category_label": "Pre-submitted", "deletion_blocker": "Move the records in this stage before removing it.", "id": "dstg_a1b2c3d4e5f6g7h8", "name": "Preparing application", "object": "deal_stage", "record_count": 3 } ] }, "properties": { "categories": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "key": { "type": "string" }, "label": { "type": "string" } }, "required": [ "key", "label", "description" ], "type": "object" }, "type": "array" }, "revision": { "type": "string" }, "stages": { "items": { "additionalProperties": false, "properties": { "category_key": { "maxLength": 100, "type": "string" }, "category_label": { "type": "string" }, "deletion_blocker": { "description": "Why this stage must remain in the workflow, or null when it can be removed.", "type": [ "string", "null" ] }, "id": { "pattern": "^dstg_[a-z0-9]+$", "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "object": { "const": "deal_stage", "type": "string" }, "record_count": { "description": "Records referencing this stage, including records excluded from API collections. Used for stage removal checks; not a collection total.", "type": "integer" } }, "required": [ "id", "object", "name", "category_key", "category_label", "record_count", "deletion_blocker" ], "type": "object" }, "type": "array" } }, "required": [ "revision", "categories", "stages" ], "type": "object" } } }, "description": "Current provider workflows", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-pipelines/update-deal-stage-configuration/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-pipelines/update-deal-stage-configuration/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-pipelines/update-deal-stage-configuration/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-pipelines/update-deal-stage-configuration/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-pipelines/update-deal-stage-configuration/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-pipelines/update-deal-stage-configuration/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-pipelines/update-deal-stage-configuration/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Manage one provider workflow" } }, "/deal-recipients/": { "get": { "description": "Choose who should receive a Deal: your own team, a Marketplace lender, a connected partner, or a custom recipient available to your Portal. Choose an item with can_create_deal: true and copy its id into recipient_id when creating a Deal. Otherwise, unavailable_reason explains what needs attention.", "operationId": "listDealRecipients", "parameters": [ { "description": "Search recipient names.", "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Defaults to name, with id as the tie-breaker.", "in": "query", "name": "ordering", "schema": { "enum": [ "name", "-name" ], "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealRecipientPage" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-recipients/list-deal-recipients/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-recipients/list-deal-recipients/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-recipients/list-deal-recipients/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-recipients/list-deal-recipients/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-recipients/list-deal-recipients/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-recipients/list-deal-recipients/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-recipients/list-deal-recipients/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deal-recipients/list-deal-recipients/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List Deal recipients" } }, "/deals/": { "get": { "operationId": "listDeals", "parameters": [ { "in": "query", "name": "search", "schema": { "type": "string" } }, { "in": "query", "name": "ordering", "schema": { "enum": [ "name", "-name", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "project_id", "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "description": "Return archived records when true; active records otherwise. Fictional onboarding examples are excluded.", "in": "query", "name": "archived", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealPage" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deals/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deals/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deals/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deals/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deals/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deals/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deals/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deals/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List Deals" }, "post": { "description": "Start a Deal for an existing Business and a recipient, including your own Portal or a custom email recipient. Choose an id from List Deal recipients. Or use recipient.id from a matchmaking result. Uses the recipient's current published application and your default Deal pipeline. Creation keeps the application private to your team, starts Autofill, and does not submit it. Include project_id to link a Project belonging to this Business; this requires Projects write access. An identical retry with the same Idempotency-Key returns the original Deal.", "operationId": "createDeal", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "business_id": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "project_id": { "pattern": "^proj_[a-z0-9]+$", "type": "string" }, "recipient_id": { "description": "Recipient id returned by List Deal recipients or recipient.id from matchmaking.", "example": "northstar-finance", "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "business_id", "recipient_id" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/create-deal/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/create-deal/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/create-deal/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/create-deal/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/create-deal/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/create-deal/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/create-deal/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/create-deal/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Create a Deal" } }, "/deals/{deal_id}/": { "get": { "operationId": "retrieveDeal", "parameters": [ { "in": "path", "name": "deal_id", "required": true, "schema": { "pattern": "^deal_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Retrieve a Deal" }, "patch": { "description": "Change the Deal name shown in your Portal without changing application answers, submission status, assignment, or pipeline stage. Read the Deal first and pass its latest revision in If-Match.", "operationId": "updateDeal", "parameters": [ { "in": "path", "name": "deal_id", "required": true, "schema": { "pattern": "^deal_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Update a Deal" } }, "/deals/{deal_id}/participants/": { "get": { "operationId": "listDealParticipants", "parameters": [ { "in": "path", "name": "deal_id", "required": true, "schema": { "pattern": "^deal_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealParticipants" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deal-participants/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deal-participants/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deal-participants/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deal-participants/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deal-participants/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deal-participants/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deal-participants/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/list-deal-participants/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List Deal participants" }, "put": { "operationId": "replaceDealParticipants", "parameters": [ { "in": "path", "name": "deal_id", "required": true, "schema": { "pattern": "^deal_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "person_ids": { "items": { "pattern": "^pers_[a-z0-9]+$", "type": "string" }, "maxItems": 500, "type": "array", "uniqueItems": true }, "primary_person_id": { "anyOf": [ { "pattern": "^pers_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "person_ids" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealParticipants" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/replace-deal-participants/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/replace-deal-participants/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/replace-deal-participants/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/replace-deal-participants/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/replace-deal-participants/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/replace-deal-participants/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/replace-deal-participants/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/replace-deal-participants/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Replace Deal participants" } }, "/deals/{deal_id}/project/": { "post": { "description": "Requires deals and projects write access. Supply project_id for an existing Project or name and optional request terms to create one. Preserves the application, source attribution and grants. New commands replace the association; replay returns the original result without moving it back.", "operationId": "setDealProject", "parameters": [ { "in": "path", "name": "deal_id", "required": true, "schema": { "pattern": "^deal_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "additionalProperties": false, "properties": { "project_id": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, "required": [ "project_id" ], "type": "object" }, { "additionalProperties": false, "dependentRequired": { "target_amount": [ "target_currency" ], "target_currency": [ "target_amount" ] }, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "purpose": { "maxLength": 10000, "type": "string" }, "target_amount": { "pattern": "^[0-9]+(?:\\.[0-9]{1,2})?$", "type": "string" }, "target_currency": { "enum": [ "USD", "CAD" ], "type": "string" } }, "required": [ "name" ], "type": "object" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealProjectAssociation" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/set-deal-project/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/set-deal-project/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/set-deal-project/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/set-deal-project/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/set-deal-project/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/set-deal-project/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/set-deal-project/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/set-deal-project/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Associate an existing Deal with a Project" } }, "/deals/{deal_id}/stage/": { "patch": { "operationId": "moveDealStage", "parameters": [ { "in": "path", "name": "deal_id", "required": true, "schema": { "pattern": "^deal_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "stage_id": { "pattern": "^dstg_[a-z0-9]+$", "type": "string" } }, "required": [ "stage_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealStageTransition" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/move-deal-stage/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/move-deal-stage/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/move-deal-stage/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/move-deal-stage/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/move-deal-stage/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/move-deal-stage/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/move-deal-stage/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/move-deal-stage/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Move one Deal to a workflow stage" } }, "/deals/{deal_id}/terms/": { "get": { "operationId": "retrieveDealTerms", "parameters": [ { "in": "path", "name": "deal_id", "required": true, "schema": { "pattern": "^deal_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTerms" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal-terms/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal-terms/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal-terms/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal-terms/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal-terms/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal-terms/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal-terms/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/retrieve-deal-terms/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Retrieve Deal financing terms" }, "patch": { "description": "Patch financing details with the current revision. Omitted fields stay unchanged. equipment_entries replaces the complete equipment list; [] clears it. Application answers and lifecycle decisions use their own operations.", "operationId": "updateDealTerms", "parameters": [ { "in": "path", "name": "deal_id", "required": true, "schema": { "pattern": "^deal_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "minProperties": 1, "properties": { "actual_interest_rate": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "additional_notes": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "advance_rate_percent": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "advisory_fee_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "advisory_fee_percent": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "buy_rate": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "commission_actual_payment_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ] }, "commission_notes": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "commission_status": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "pattern": "^[A-Za-z]{3}$", "type": "string" }, { "type": "null" } ] }, "deal_length_interval": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "deal_length_value": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "deal_revenue": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "deal_status": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "deal_type": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "disbursed_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ] }, "equipment_entries": { "description": "The complete equipment list. Replaces the existing list when supplied; [] clears it.", "items": { "additionalProperties": false, "properties": { "equipment_condition": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ] }, "equipment_description": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "equipment_manufacturer_make_model": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "equipment_structure": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "equipment_type": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ] }, "equipment_value_or_cost": { "anyOf": [ { "pattern": "^[0-9]{1,10}(?:\\.[0-9]{1,2})?$", "type": "string" }, { "type": "null" } ] }, "equipment_vendor_or_supplier": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "position": { "minimum": 0, "type": "integer" } }, "type": "object" }, "maxItems": 100, "type": "array" }, "factor_rate": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "financing_type": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "funded_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "is_stacked_deal": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "is_syndication": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "maturity_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ] }, "net_funded_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "not_applicable_fields": { "items": { "type": "string" }, "maxItems": 64, "type": "array" }, "notes_to_accounting": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "nr_payments": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "offered_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "origination_fee_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "origination_fee_percent": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "other_fee": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "other_fee_description": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "payment_frequency_interval": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "processing_fee": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "property_loan_to_value": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "property_type": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "property_use": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "property_value": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "proposed_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "real_estate_property_address": { "anyOf": [ { "maxProperties": 64, "type": "object" }, { "type": "null" } ] }, "renewal_followup_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ] }, "repayment_holdback_percentage": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "repayment_payment_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "requested_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "sell_rate": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "stacked_with": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "syndication_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "syndication_percent": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] }, "target_interest_rate": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ] }, "total_repayment_amount": { "anyOf": [ { "pattern": "^-?[0-9]{1,12}(?:\\.[0-9]{1,3})?$", "type": "string" }, { "type": "null" } ] } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealTerms" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal-terms/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal-terms/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal-terms/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal-terms/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal-terms/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal-terms/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal-terms/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/deals/update-deal-terms/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Update Deal financing terms" } }, "/lenders/": { "get": { "operationId": "listLenders", "parameters": [ { "in": "query", "name": "search", "schema": { "type": "string" } }, { "in": "query", "name": "ordering", "schema": { "enum": [ "name", "-name", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LenderPage" } } }, "description": "Lender page.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/lenders/list-lenders/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/lenders/list-lenders/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/lenders/list-lenders/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/lenders/list-lenders/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/lenders/list-lenders/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/lenders/list-lenders/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List visible lenders" } }, "/lenders/{lender_id}/": { "get": { "operationId": "retrieveLender", "parameters": [ { "in": "path", "name": "lender_id", "required": true, "schema": { "pattern": "^lndr_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LenderDetail" } } }, "description": "Lender details.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/lenders/retrieve-lender/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/lenders/retrieve-lender/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/lenders/retrieve-lender/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/lenders/retrieve-lender/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/lenders/retrieve-lender/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/lenders/retrieve-lender/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Retrieve a lender and published requirements" } }, "/people/": { "get": { "operationId": "listPeople", "parameters": [ { "in": "query", "name": "search", "schema": { "type": "string" } }, { "in": "query", "name": "tag", "schema": { "type": "string" } }, { "in": "query", "name": "ordering", "schema": { "enum": [ "name", "-name", "created_at", "-created_at", "updated_at", "-updated_at" ], "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonPage" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/list-people/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/list-people/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/list-people/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/list-people/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/list-people/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/list-people/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/list-people/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/list-people/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List CRM people" }, "post": { "operationId": "createPerson", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "minProperties": 1, "properties": { "company_name": { "maxLength": 500, "type": "string" }, "email": { "format": "email", "maxLength": 254, "type": "string" }, "full_name": { "maxLength": 500, "type": "string" }, "is_do_not_contact": { "type": "boolean" }, "job_title": { "maxLength": 500, "type": "string" }, "notes": { "maxLength": 10000, "type": "string" }, "phone_number": { "maxLength": 500, "type": "string" } }, "required": [ "email" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/create-person/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/create-person/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/create-person/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/create-person/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/create-person/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/create-person/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/create-person/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/create-person/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Create a CRM person" } }, "/people/{person_id}/": { "get": { "operationId": "retrievePerson", "parameters": [ { "in": "path", "name": "person_id", "required": true, "schema": { "pattern": "^pers_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/retrieve-person/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/retrieve-person/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/retrieve-person/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/retrieve-person/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/retrieve-person/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/retrieve-person/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/retrieve-person/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/retrieve-person/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Retrieve a CRM person" }, "patch": { "operationId": "updatePerson", "parameters": [ { "in": "path", "name": "person_id", "required": true, "schema": { "pattern": "^pers_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "minProperties": 1, "properties": { "company_name": { "maxLength": 500, "type": "string" }, "email": { "format": "email", "maxLength": 254, "type": "string" }, "full_name": { "maxLength": 500, "type": "string" }, "is_do_not_contact": { "type": "boolean" }, "job_title": { "maxLength": 500, "type": "string" }, "notes": { "maxLength": 10000, "type": "string" }, "phone_number": { "maxLength": 500, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/update-person/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/update-person/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/update-person/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/update-person/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/update-person/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/update-person/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/update-person/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/update-person/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Update a CRM person" } }, "/people/{person_id}/tags/": { "put": { "operationId": "replacePersonTags", "parameters": [ { "in": "path", "name": "person_id", "required": true, "schema": { "pattern": "^pers_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "tag_names": { "items": { "type": "string" }, "maxItems": 50, "type": "array", "uniqueItems": true } }, "required": [ "tag_names" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/replace-person-tags/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/replace-person-tags/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/replace-person-tags/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/replace-person-tags/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/replace-person-tags/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/replace-person-tags/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/replace-person-tags/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/people/replace-person-tags/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Replace CRM person tags" } }, "/project-matchmaking-application-autofill-runs/{run_id}/": { "get": { "description": "Poll the run id returned by start or retry until status is completed or failed. A completed run may still report warnings and retryable work.", "operationId": "getProjectMatchmakingApplicationAutofillRun", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingApplicationAutofillRun" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-run/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-run/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-run/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-run/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-run/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-run/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-run/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-run/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Poll matchmaking application autofill" } }, "/project-matchmaking-application-autofill-runs/{run_id}/retry/": { "post": { "description": "Retry only unresolved work from this settled run. Completed suggestions and the frozen preparation remain unchanged; poll the same run id for the new attempt.", "operationId": "retryProjectMatchmakingApplicationAutofillRun", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingApplicationAutofillRun" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-application-autofill-run/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-application-autofill-run/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-application-autofill-run/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-application-autofill-run/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-application-autofill-run/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-application-autofill-run/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-application-autofill-run/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-application-autofill-run/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Retry unfinished matchmaking application autofill work" } }, "/project-matchmaking-application-autofill-runs/{run_id}/suggestions/": { "get": { "description": "Review a cursor-paginated page of persisted proposed values and evidence. Review one pending suggestion's proposed value, evidence, and concerns. Read the current answers, then POST to the Run's suggestions_url plus {suggestion_id}/accept/ with no request body, the answer ETag in If-Match, and a unique Idempotency-Key. Levr checks the answer revision and target drift, applies the proposal, and records acceptance in one transaction. A 412 means the answers changed; reread and review before issuing a new command. A 409 suggestion_conflict means the suggestion is stale, superseded, or already resolved; refresh suggestions and review again. An identical retry must reuse the original precondition and key. Check the returned suggestion is accepted and verify the intended value through the answers read. Use the returned ETag for the next answer mutation. Do not copy proposal metadata into an answer-update request to accept a suggestion.", "operationId": "listProjectMatchmakingApplicationAutofillSuggestions", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" } }, { "description": "Search section, question, field labels, and source excerpts.", "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Filter by one status, ignoring letter case: pending, accepted, dismissed, stale, failed.", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "Comma-separated display_order, created_at, updated_at, or status; prefix - for descending. Defaults to display_order,created_at.", "in": "query", "name": "ordering", "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingApplicationAutofillSuggestionPage" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-autofill-suggestions/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-autofill-suggestions/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-autofill-suggestions/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-autofill-suggestions/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-autofill-suggestions/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-autofill-suggestions/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-autofill-suggestions/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-autofill-suggestions/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List matchmaking application autofill suggestions" } }, "/project-matchmaking-application-autofill-runs/{run_id}/suggestions/{suggestion_id}/accept/": { "post": { "description": "Review one pending suggestion's proposed value, evidence, and concerns. Read the current answers, then POST to the Run's suggestions_url plus {suggestion_id}/accept/ with no request body, the answer ETag in If-Match, and a unique Idempotency-Key. Levr checks the answer revision and target drift, applies the proposal, and records acceptance in one transaction. A 412 means the answers changed; reread and review before issuing a new command. A 409 suggestion_conflict means the suggestion is stale, superseded, or already resolved; refresh suggestions and review again. An identical retry must reuse the original precondition and key. Check the returned suggestion is accepted and verify the intended value through the answers read. Use the returned ETag for the next answer mutation. Do not copy proposal metadata into an answer-update request to accept a suggestion.", "operationId": "acceptProjectMatchmakingAutofillSuggestion", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" } }, { "in": "path", "name": "suggestion_id", "required": true, "schema": { "pattern": "^afsug_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "description": "The ETag returned by the current answers read.", "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingApplicationAutofillSuggestionAcceptance" } } }, "description": "The suggestion was accepted, or an identical request was replayed.", "headers": { "ETag": { "schema": { "type": "string" } }, "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/accept-project-matchmaking-autofill-suggestion/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/accept-project-matchmaking-autofill-suggestion/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/accept-project-matchmaking-autofill-suggestion/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/accept-project-matchmaking-autofill-suggestion/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/accept-project-matchmaking-autofill-suggestion/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/accept-project-matchmaking-autofill-suggestion/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/accept-project-matchmaking-autofill-suggestion/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/accept-project-matchmaking-autofill-suggestion/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Accept autofill suggestion" } }, "/project-matchmaking-runs/{run_id}/": { "get": { "operationId": "retrieveProjectMatchmakingRun", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^pmrun_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchmakingRun" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-run/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-run/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-run/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-run/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-run/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-run/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-run/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-run/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Poll a match calculation" } }, "/project-matchmaking-runs/{run_id}/cancel/": { "post": { "operationId": "cancelProjectMatchmakingRun", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^pmrun_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchmakingRun" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/cancel-project-matchmaking-run/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/cancel-project-matchmaking-run/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/cancel-project-matchmaking-run/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/cancel-project-matchmaking-run/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/cancel-project-matchmaking-run/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/cancel-project-matchmaking-run/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/cancel-project-matchmaking-run/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/cancel-project-matchmaking-run/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Cancel unresolved recipient matching" } }, "/project-matchmaking-runs/{run_id}/results/": { "get": { "operationId": "listProjectMatchmakingResults", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^pmrun_[a-z0-9]+$", "type": "string" } }, { "description": "Search recipient labels and provider names.", "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Comma-separated classification, recipient_kind, or created_at; prefix - for descending. Defaults to classification,recipient_kind.", "in": "query", "name": "ordering", "schema": { "type": "string" } }, { "description": "Filter by one classification using its exact value.", "in": "query", "name": "classification", "schema": { "enum": [ "match", "partial_fit", "insufficient_information", "not_a_match", "not_assessed" ], "type": "string" } }, { "description": "Filter by one state using its exact value.", "in": "query", "name": "state", "schema": { "enum": [ "pending", "completed", "failed", "cancelled" ], "type": "string" } }, { "description": "Filter by the exact recipient_kind returned in a result.", "in": "query", "name": "recipient_kind", "schema": { "type": "string" } }, { "in": "query", "name": "selected", "schema": { "type": "boolean" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingResultPage" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-results/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-results/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-results/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-results/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-results/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-results/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-results/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-results/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List persisted match results" } }, "/project-matchmaking-runs/{run_id}/retry/": { "post": { "operationId": "retryProjectMatchmakingRun", "parameters": [ { "in": "path", "name": "run_id", "required": true, "schema": { "pattern": "^pmrun_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchmakingRun" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-run/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-run/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-run/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-run/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-run/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-run/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-run/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retry-project-matchmaking-run/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Retry failed recipient matches" } }, "/project-stages/": { "get": { "operationId": "getProjectStageConfiguration", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "example": { "categories": [ { "description": "Work continues, including monitoring funded facilities.", "key": "active", "label": "Active work" }, { "description": "No current Project work remains. Applications stay unchanged.", "key": "closed", "label": "Closed" } ], "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "stages": [ { "category_key": "active", "category_label": "Active work", "deletion_blocker": "Move the records in this stage before removing it.", "id": "pstg_a1b2c3d4e5f6g7h8", "name": "Open", "object": "project_stage", "record_count": 3 }, { "category_key": "closed", "category_label": "Closed", "deletion_blocker": "Move the records in this stage before removing it.", "id": "pstg_b2c3d4e5f6g7h8i9", "name": "Closed", "object": "project_stage", "record_count": 1 } ] }, "properties": { "categories": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "key": { "type": "string" }, "label": { "type": "string" } }, "required": [ "key", "label", "description" ], "type": "object" }, "type": "array" }, "revision": { "type": "string" }, "stages": { "items": { "additionalProperties": false, "properties": { "category_key": { "maxLength": 100, "type": "string" }, "category_label": { "type": "string" }, "deletion_blocker": { "description": "Why this stage must remain in the workflow, or null when it can be removed.", "type": [ "string", "null" ] }, "id": { "pattern": "^pstg_[a-z0-9]+$", "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "object": { "const": "project_stage", "type": "string" }, "record_count": { "description": "Records referencing this stage, including records excluded from API collections. Used for stage removal checks; not a collection total.", "type": "integer" } }, "required": [ "id", "object", "name", "category_key", "category_label", "record_count", "deletion_blocker" ], "type": "object" }, "type": "array" } }, "required": [ "revision", "categories", "stages" ], "type": "object" } } }, "description": "Current provider workflows", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/project-stages/get-project-stage-configuration/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/project-stages/get-project-stage-configuration/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/project-stages/get-project-stage-configuration/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/project-stages/get-project-stage-configuration/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/project-stages/get-project-stage-configuration/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/project-stages/get-project-stage-configuration/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/project-stages/get-project-stage-configuration/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Read project stages" }, "put": { "description": "Read first. Send the complete desired stage list and that workflow's expected_revision. Existing categories cannot change. Follow the stage creation fields in this resource schema. Omit a stage only when its deletion_blocker is null. Records are never moved by a configuration edit. Reuse Idempotency-Key only for an identical retry.", "operationId": "updateProjectStageConfiguration", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "example": { "expected_revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "stages": [ { "category_key": "active", "id": "pstg_a1b2c3d4e5f6g7h8", "name": "New enquiry" }, { "category_key": "closed", "id": "pstg_b2c3d4e5f6g7h8i9", "name": "Closed" } ] }, "properties": { "expected_revision": { "maxLength": 64, "minLength": 64, "type": "string" }, "stages": { "items": { "additionalProperties": false, "properties": { "category_key": { "maxLength": 100, "type": "string" }, "id": { "pattern": "^pstg_[a-z0-9]+$", "type": "string" }, "name": { "maxLength": 127, "minLength": 1, "type": "string" } }, "required": [ "name", "category_key" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "expected_revision", "stages" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "example": { "categories": [ { "description": "Work continues, including monitoring funded facilities.", "key": "active", "label": "Active work" }, { "description": "No current Project work remains. Applications stay unchanged.", "key": "closed", "label": "Closed" } ], "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "stages": [ { "category_key": "active", "category_label": "Active work", "deletion_blocker": "Move the records in this stage before removing it.", "id": "pstg_a1b2c3d4e5f6g7h8", "name": "Open", "object": "project_stage", "record_count": 3 }, { "category_key": "closed", "category_label": "Closed", "deletion_blocker": "Move the records in this stage before removing it.", "id": "pstg_b2c3d4e5f6g7h8i9", "name": "Closed", "object": "project_stage", "record_count": 1 } ] }, "properties": { "categories": { "items": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "key": { "type": "string" }, "label": { "type": "string" } }, "required": [ "key", "label", "description" ], "type": "object" }, "type": "array" }, "revision": { "type": "string" }, "stages": { "items": { "additionalProperties": false, "properties": { "category_key": { "maxLength": 100, "type": "string" }, "category_label": { "type": "string" }, "deletion_blocker": { "description": "Why this stage must remain in the workflow, or null when it can be removed.", "type": [ "string", "null" ] }, "id": { "pattern": "^pstg_[a-z0-9]+$", "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "object": { "const": "project_stage", "type": "string" }, "record_count": { "description": "Records referencing this stage, including records excluded from API collections. Used for stage removal checks; not a collection total.", "type": "integer" } }, "required": [ "id", "object", "name", "category_key", "category_label", "record_count", "deletion_blocker" ], "type": "object" }, "type": "array" } }, "required": [ "revision", "categories", "stages" ], "type": "object" } } }, "description": "Current provider workflows", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/project-stages/update-project-stage-configuration/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/project-stages/update-project-stage-configuration/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/project-stages/update-project-stage-configuration/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/project-stages/update-project-stage-configuration/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/project-stages/update-project-stage-configuration/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/project-stages/update-project-stage-configuration/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/project-stages/update-project-stage-configuration/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Manage one provider workflow" } }, "/projects/": { "get": { "operationId": "listProjects", "parameters": [ { "in": "query", "name": "search", "schema": { "type": "string" } }, { "in": "query", "name": "ordering", "schema": { "enum": [ "name", "-name", "created_at", "-created_at", "updated_at", "-updated_at", "decision_due_date", "-decision_due_date" ], "type": "string" } }, { "in": "query", "name": "stage", "schema": { "pattern": "^pstg_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "business_id", "schema": { "pattern": "^biz_[a-z0-9]+$", "type": "string" } }, { "description": "Return archived records when true; active records otherwise. Fictional onboarding examples are excluded.", "in": "query", "name": "archived", "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectPage" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-projects/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-projects/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-projects/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-projects/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-projects/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-projects/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-projects/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-projects/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List Projects" }, "post": { "operationId": "createProject", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "oneOf": [ { "required": [ "name" ] }, { "maxProperties": 2, "required": [ "service_request_id" ] } ], "properties": { "business_id": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "decision_due_date": { "format": "date", "type": [ "string", "null" ] }, "flexibility_notes": { "type": "string" }, "name": { "type": "string" }, "purpose": { "type": "string" }, "service_request_id": { "description": "Continue an authorized client request returned by GET /businesses/{business_id}/activation/, preserving its matching work. The API key also needs businesses:read. Send business_id and service_request_id only.", "pattern": "^srq_[a-z0-9]+$", "type": "string" }, "target_amount": { "type": [ "string", "number", "null" ] }, "target_currency": { "type": [ "string", "null" ] } }, "required": [ "business_id" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Create a Project" } }, "/projects/{project_id}/": { "get": { "operationId": "retrieveProject", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Retrieve a Project" }, "patch": { "operationId": "updateProject", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "minProperties": 1, "properties": { "decision_due_date": { "format": "date", "type": [ "string", "null" ] }, "flexibility_notes": { "type": "string" }, "name": { "maxLength": 255, "minLength": 1, "type": "string" }, "purpose": { "type": "string" }, "target_amount": { "pattern": "^[0-9]{1,12}(?:\\.[0-9]{1,2})?$", "type": [ "string", "null" ] }, "target_currency": { "pattern": "^[A-Za-z]{3}$", "type": [ "string", "null" ] } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Update Project facts" } }, "/projects/{project_id}/matchmaking-application/answers/": { "get": { "operationId": "listProjectMatchmakingAnswers", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "section", "schema": { "type": "string" } }, { "in": "query", "name": "search", "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 50, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingAnswerPage" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-answers/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-answers/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-answers/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-answers/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-answers/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-answers/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-answers/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-answers/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List shared matchmaking application answers" }, "patch": { "operationId": "updateProjectMatchmakingAnswers", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "updates": { "items": { "additionalProperties": false, "properties": { "block_key": { "description": "block_key returned by the answer read.", "maxLength": 64, "minLength": 1, "type": "string" }, "field_key": { "description": "field_key returned by the answer read.", "maxLength": 512, "minLength": 1, "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ], "description": "Replacement answer value." } }, "required": [ "block_key", "field_key", "value" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "updates" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingAnswerMutation" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-answers/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-answers/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-answers/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-answers/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-answers/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-answers/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-answers/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-answers/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Update shared matchmaking application answers" } }, "/projects/{project_id}/matchmaking-application/answers/files/": { "delete": { "description": "Delete one uploaded file while preserving its repeatable row, when present.", "operationId": "deleteProjectMatchmakingApplicationAnswerFile", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "file_id": { "pattern": "^ansfile_[a-z0-9]+$", "type": "string" } }, "required": [ "file_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-answer-file/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-answer-file/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-answer-file/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-answer-file/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-answer-file/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-answer-file/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-answer-file/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-answer-file/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-answer-file/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Delete an answer file" }, "get": { "description": "List uploaded file metadata and fresh download URLs. Optionally filter by a contract block_key or repeatable item_id.", "operationId": "listProjectMatchmakingApplicationAnswerFiles", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "block_key", "schema": { "type": "string" } }, { "in": "query", "name": "item_id", "schema": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 50, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "items": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "download_url": { "format": "uri", "type": "string" }, "filename": { "type": "string" }, "id": { "pattern": "^ansfile_[a-z0-9]+$", "type": "string" }, "item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] }, "object": { "const": "answer_file", "type": "string" }, "size_bytes": { "minimum": 0, "type": [ "integer", "null" ] }, "uploaded_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "block_key", "item_id", "filename", "size_bytes", "uploaded_at" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "description": "Always null; this collection supports forward paging only.", "type": "null" } }, "required": [ "object", "items", "next_cursor", "previous_cursor", "answers_revision" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-answer-files/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-answer-files/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-answer-files/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-answer-files/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-answer-files/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-answer-files/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-answer-files/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-answer-files/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-answer-files/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List answer files" }, "post": { "description": "Request a one-hour upload capability for a file question. For a file inside a repeatable group, include that group's item_id.", "operationId": "createProjectMatchmakingApplicationAnswerFileUpload", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "block_key" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expires_at": { "format": "date-time", "type": "string" }, "id": { "pattern": "^upl_.+$", "type": "string" }, "max_size_bytes": { "minimum": 1, "type": "integer" }, "multipart_field": { "const": "file", "type": "string" }, "object": { "const": "file_upload", "type": "string" }, "upload_url": { "format": "uri", "type": "string" } }, "required": [ "id", "object", "upload_url", "expires_at", "max_size_bytes", "multipart_field" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-answer-file-upload/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-answer-file-upload/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-answer-file-upload/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-answer-file-upload/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-answer-file-upload/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-answer-file-upload/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-answer-file-upload/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-answer-file-upload/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-answer-file-upload/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Request an answer-file upload" } }, "/projects/{project_id}/matchmaking-application/answers/files/{upload_id}/": { "post": { "description": "Redeem the upload_url with exactly one multipart field named file. Use the latest answers ETag as If-Match and a unique Idempotency-Key.", "operationId": "uploadProjectMatchmakingApplicationAnswerFile", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "path", "name": "upload_id", "required": true, "schema": { "pattern": "^upl_.+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "properties": { "file": { "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-answer-file/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-answer-file/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-answer-file/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-answer-file/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-answer-file/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-answer-file/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-answer-file/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-answer-file/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-answer-file/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Upload an answer file" } }, "/projects/{project_id}/matchmaking-application/answers/repeatable-items/": { "delete": { "description": "Delete one repeated row and all answers nested inside it.", "operationId": "deleteProjectMatchmakingApplicationRepeatableItem", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" } }, "required": [ "item_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "affected_section_keys": { "items": { "type": "string" }, "type": "array" }, "answers_revision": { "minimum": 0, "type": "integer" }, "deleted_item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "item": { "additionalProperties": false, "properties": { "answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] }, "value_type": { "type": "string" } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value_type", "value" ], "type": "object" }, "type": "array" }, "block_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "order": { "minimum": 0, "type": "integer" }, "parent_item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "item_id", "block_key", "parent_item_id", "order", "answers" ], "type": "object" }, "object": { "type": "string" }, "resource": { "type": "object" }, "updated_answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "object", "resource", "answers_revision", "affected_section_keys" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-repeatable-item/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-repeatable-item/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-repeatable-item/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-repeatable-item/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-repeatable-item/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-repeatable-item/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-repeatable-item/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-repeatable-item/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/delete-project-matchmaking-application-repeatable-item/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Delete a repeatable answer item" }, "get": { "description": "List the stable rows in one repeatable group. Pass the group's block_key from the live Application Contract.", "operationId": "listProjectMatchmakingApplicationRepeatableItems", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "block_key", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 50, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "items": { "items": { "additionalProperties": false, "properties": { "answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] }, "value_type": { "type": "string" } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value_type", "value" ], "type": "object" }, "type": "array" }, "block_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "order": { "minimum": 0, "type": "integer" }, "parent_item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "item_id", "block_key", "parent_item_id", "order", "answers" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "object": { "const": "list", "type": "string" }, "previous_cursor": { "description": "Always null; this collection supports forward paging only.", "type": "null" } }, "required": [ "object", "items", "next_cursor", "previous_cursor", "answers_revision" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-repeatable-items/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-repeatable-items/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-repeatable-items/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-repeatable-items/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-repeatable-items/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-repeatable-items/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-repeatable-items/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-repeatable-items/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-application-repeatable-items/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List repeatable answer items" }, "patch": { "description": "Replace one or more scalar fields inside exactly one stable repeated row.", "operationId": "updateProjectMatchmakingApplicationRepeatableItem", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "updates": { "items": { "additionalProperties": false, "properties": { "block_key": { "description": "block_key returned by the answer read.", "maxLength": 64, "minLength": 1, "type": "string" }, "field_key": { "description": "field_key returned by the answer read.", "maxLength": 512, "minLength": 1, "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ], "description": "Replacement answer value." } }, "required": [ "block_key", "field_key", "value" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "item_id", "updates" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "affected_section_keys": { "items": { "type": "string" }, "type": "array" }, "answers_revision": { "minimum": 0, "type": "integer" }, "deleted_item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "item": { "additionalProperties": false, "properties": { "answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] }, "value_type": { "type": "string" } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value_type", "value" ], "type": "object" }, "type": "array" }, "block_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "order": { "minimum": 0, "type": "integer" }, "parent_item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "item_id", "block_key", "parent_item_id", "order", "answers" ], "type": "object" }, "object": { "type": "string" }, "resource": { "type": "object" }, "updated_answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "object", "resource", "answers_revision", "affected_section_keys" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-repeatable-item/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-repeatable-item/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-repeatable-item/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-repeatable-item/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-repeatable-item/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-repeatable-item/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-repeatable-item/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-repeatable-item/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-repeatable-item/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Update a repeatable answer item" }, "post": { "description": "Create an empty row, then use its returned item_id for field updates or files.", "operationId": "createProjectMatchmakingApplicationRepeatableItem", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "parent_item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "block_key" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "affected_section_keys": { "items": { "type": "string" }, "type": "array" }, "answers_revision": { "minimum": 0, "type": "integer" }, "deleted_item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "item": { "additionalProperties": false, "properties": { "answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] }, "value_type": { "type": "string" } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value_type", "value" ], "type": "object" }, "type": "array" }, "block_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "order": { "minimum": 0, "type": "integer" }, "parent_item_id": { "anyOf": [ { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "item_id", "block_key", "parent_item_id", "order", "answers" ], "type": "object" }, "object": { "type": "string" }, "resource": { "type": "object" }, "updated_answers": { "items": { "additionalProperties": false, "properties": { "block_key": { "type": "string" }, "field_key": { "type": "string" }, "item_id": { "pattern": "^ansitem_[a-z0-9]+$", "type": "string" }, "schema_key": { "type": "string" }, "value": { "anyOf": [ { "type": "null" }, { "maxLength": 10000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "maxLength": 1000, "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "maxItems": 100, "type": "array" } ] } }, "required": [ "item_id", "block_key", "schema_key", "field_key", "value" ], "type": "object" }, "type": "array" } }, "required": [ "object", "resource", "answers_revision", "affected_section_keys" ], "type": "object" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-repeatable-item/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-repeatable-item/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-repeatable-item/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-repeatable-item/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-repeatable-item/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-repeatable-item/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-repeatable-item/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-repeatable-item/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/create-project-matchmaking-application-repeatable-item/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Create a repeatable answer item" } }, "/projects/{project_id}/matchmaking-application/autofill-preparation/": { "get": { "description": "Read the notes and evidence counts that a later autofill run will use. This operation does not upload file bytes; use Upload one autofill preparation file to attach each new file before starting.", "operationId": "getProjectMatchmakingApplicationAutofillPreparation", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingApplicationAutofillPreparation" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-preparation/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-preparation/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-preparation/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-preparation/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-preparation/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-preparation/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-preparation/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-application-autofill-preparation/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Get matchmaking application autofill preparation" }, "patch": { "description": "Save notes or mode without starting autofill. Pass the ETag from the latest preparation read in If-Match. Send an empty text_input to clear saved notes.", "operationId": "updateProjectMatchmakingApplicationAutofillPreparation", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "example": { "ai_mode": "fast", "text_input": "Use the signed financial statements." }, "minProperties": 1, "properties": { "ai_mode": { "enum": [ "fast", "thinking" ], "type": "string" }, "text_input": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingApplicationAutofillPreparation" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-autofill-preparation/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-autofill-preparation/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-autofill-preparation/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-autofill-preparation/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-autofill-preparation/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-autofill-preparation/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-autofill-preparation/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-application-autofill-preparation/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Update matchmaking application autofill preparation" } }, "/projects/{project_id}/matchmaking-application/autofill-preparation/files/": { "post": { "description": "Upload one bounded multipart file, repeat as needed, then start autofill with the latest returned preparation revision. Pass the latest preparation ETag in If-Match so concurrent changes are not silently overwritten.", "operationId": "uploadProjectMatchmakingApplicationAutofillPreparationFile", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "properties": { "file": { "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingApplicationAutofillPreparationFileUpload" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-autofill-preparation-file/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-autofill-preparation-file/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-autofill-preparation-file/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-autofill-preparation-file/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-autofill-preparation-file/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-autofill-preparation-file/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-autofill-preparation-file/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/upload-project-matchmaking-application-autofill-preparation-file/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Upload one autofill preparation file" } }, "/projects/{project_id}/matchmaking-application/autofill-runs/": { "post": { "description": "Start asynchronous autofill using the current notes and files already attached to the preparation. Poll the returned run or subscribe to its settled webhook.", "operationId": "startProjectMatchmakingApplicationAutofill", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "ai_mode": { "enum": [ "fast", "thinking" ], "type": "string" }, "expected_preparation_revision": { "minimum": 1, "type": "integer" }, "selected_evidence_source_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "expected_preparation_revision" ], "type": "object" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingApplicationAutofillRun" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/start-project-matchmaking-application-autofill/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/start-project-matchmaking-application-autofill/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/start-project-matchmaking-application-autofill/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/start-project-matchmaking-application-autofill/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/start-project-matchmaking-application-autofill/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/start-project-matchmaking-application-autofill/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/start-project-matchmaking-application-autofill/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/start-project-matchmaking-application-autofill/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Start matchmaking application autofill" } }, "/projects/{project_id}/matchmaking-application/contract/": { "get": { "operationId": "retrieveProjectMatchmakingApplicationContract", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingApplicationContract" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-application-contract/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-application-contract/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-application-contract/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-application-contract/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-application-contract/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-application-contract/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-application-contract/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/retrieve-project-matchmaking-application-contract/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Retrieve the matchmaking application contract" } }, "/projects/{project_id}/matchmaking-request/": { "get": { "operationId": "getProjectMatchmakingRequest", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingRequest" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-request/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-request/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-request/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-request/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-request/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-request/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-request/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/get-project-matchmaking-request/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Read shared matching criteria" }, "patch": { "operationId": "updateProjectMatchmakingRequest", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "example": { "decision_due_date": "2026-11-30", "flexibility_notes": "Equipment can be purchased in two phases.", "purpose": "Purchase equipment for the new workshop", "target_amount": "250000.00", "target_currency": "CAD" }, "minProperties": 1, "properties": { "decision_due_date": { "format": "date", "type": [ "string", "null" ] }, "flexibility_notes": { "type": [ "string", "null" ] }, "purpose": { "type": [ "string", "null" ] }, "target_amount": { "type": [ "string", "null" ] }, "target_currency": { "type": [ "string", "null" ] } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingRequest" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-request/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-request/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-request/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-request/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-request/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-request/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-request/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-request/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Edit shared matching criteria" } }, "/projects/{project_id}/matchmaking-runs/": { "post": { "operationId": "calculateProjectMatches", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_answers_revision": { "minimum": 0, "type": "integer" } }, "required": [ "expected_answers_revision" ], "type": "object" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MatchmakingRun" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/calculate-project-matches/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/calculate-project-matches/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/calculate-project-matches/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/calculate-project-matches/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/calculate-project-matches/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/calculate-project-matches/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/calculate-project-matches/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/calculate-project-matches/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Calculate recipient matches" } }, "/projects/{project_id}/matchmaking-selections/": { "get": { "operationId": "listProjectMatchmakingSelections", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "run_id", "schema": { "pattern": "^pmrun_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingSelections" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-selections/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-selections/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-selections/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-selections/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-selections/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-selections/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-selections/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/list-project-matchmaking-selections/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Read shared recipient choices" }, "patch": { "operationId": "updateProjectMatchmakingSelections", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "anyOf": [ { "properties": { "additions": { "minItems": 1 } }, "required": [ "additions" ] }, { "properties": { "removals": { "minItems": 1 } }, "required": [ "removals" ] } ], "properties": { "additions": { "items": { "additionalProperties": false, "properties": { "expected_package_version": { "minimum": 1, "type": "integer" }, "match_result_id": { "pattern": "^pmres_[a-z0-9]+$", "type": "string" } }, "required": [ "match_result_id", "expected_package_version" ], "type": "object" }, "type": "array" }, "removals": { "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "type": "array" }, "run_id": { "pattern": "^pmrun_[a-z0-9]+$", "type": "string" } }, "required": [ "run_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMatchmakingSelections" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-selections/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-selections/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-selections/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-selections/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-selections/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-selections/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-selections/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/update-project-matchmaking-selections/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Merge shared recipient choices" } }, "/projects/{project_id}/stage/": { "patch": { "operationId": "moveProjectStage", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "pattern": "^proj_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "pattern": "^\"?[0-9]+\"?$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "stage_id": { "pattern": "^pstg_[a-z0-9]+$", "type": "string" } }, "required": [ "stage_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectStageTransition" } } }, "description": "Successful response.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/move-project-stage/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/move-project-stage/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/move-project-stage/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/move-project-stage/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/move-project-stage/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "412": { "content": { "application/json": { "example": { "error": { "code": "precondition_failed", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/move-project-stage/", "message": "Refresh the resource and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/move-project-stage/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/projects/move-project-stage/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Move one Project to a workflow stage" } }, "/source-channels/": { "get": { "description": "Requires Businesses write access. Choose a Lead source for businesses submitted by your integration. An empty items list means this Portal has no Lead sources configured for API submissions.", "operationId": "listBusinessSourceChannels", "parameters": [ { "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Comma-separated name, created_at, or updated_at; prefix - for descending.", "in": "query", "name": "ordering", "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "created_after", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "created_before", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "updated_after", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "updated_before", "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceChannelPage" } } }, "description": "Lead sources available to this Portal and their contract URLs. Items is empty when none is configured.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/list-business-source-channels/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/list-business-source-channels/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/list-business-source-channels/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/list-business-source-channels/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "List Lead sources available for API business submissions" }, "post": { "description": "Create a Lead source to track businesses submitted by this integration. Use its business contract to discover the accepted submission fields. Check readiness before submitting businesses; if setup is missing, ask a Portal administrator to resolve it.", "operationId": "createBusinessSourceChannel", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "name": { "maxLength": 255, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceChannel" } } }, "description": "The source channel was created.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-business-source-channel/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-business-source-channel/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-business-source-channel/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-business-source-channel/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-business-source-channel/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-business-source-channel/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Create a Lead source for API business submissions" } }, "/source-channels/{source_channel_id}/": { "delete": { "description": "Requires Businesses write access and Idempotency-Key. Only API Lead sources in this Portal with no attributed businesses or Deals can be removed. Used sources return 409; attribution is never reassigned. Send no request body. Removal revokes any legacy credential owned by the source; the Portal API key remains active. Retry with the same key to replay the original successful response, even after removal.", "operationId": "removeBusinessSourceChannel", "parameters": [ { "in": "path", "name": "source_channel_id", "required": true, "schema": { "pattern": "^srcch_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "id": { "pattern": "^srcch_[a-z0-9]+$", "type": "string" }, "object": { "enum": [ "source_channel" ], "type": "string" }, "removed": { "enum": [ true ], "type": "boolean" } }, "required": [ "id", "object", "removed" ], "type": "object" } } }, "description": "The unused API Lead source was removed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/remove-business-source-channel/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/remove-business-source-channel/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/remove-business-source-channel/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/remove-business-source-channel/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/remove-business-source-channel/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/remove-business-source-channel/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/remove-business-source-channel/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Remove an unused API Lead source" } }, "/source-channels/{source_channel_id}/business-contract/": { "get": { "operationId": "getSourceChannelBusinessContract", "parameters": [ { "in": "path", "name": "source_channel_id", "required": true, "schema": { "pattern": "^srcch_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceChannelBusinessContract" } } }, "description": "The channel's current published JSON Schema and submission URL.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-source-channel-business-contract/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-source-channel-business-contract/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-source-channel-business-contract/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-source-channel-business-contract/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-source-channel-business-contract/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/get-source-channel-business-contract/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Get the current dynamic business submission contract" } }, "/source-channels/{source_channel_id}/business-files/{upload_token}/": { "post": { "description": "Use only the expiring upload URL returned by business creation.", "operationId": "uploadBusinessSubmissionFile", "parameters": [ { "in": "path", "name": "source_channel_id", "required": true, "schema": { "pattern": "^srcch_[a-z0-9]+$", "type": "string" } }, { "in": "path", "name": "upload_token", "required": true, "schema": { "pattern": "^upl_.+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "properties": { "file": { "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFileUploadResult" } } }, "description": "File stored on the requested application field.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/upload-business-submission-file/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/upload-business-submission-file/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/upload-business-submission-file/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/upload-business-submission-file/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/upload-business-submission-file/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "413": { "content": { "application/json": { "example": { "error": { "code": "payload_too_large", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/upload-business-submission-file/", "message": "The request body is too large.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/upload-business-submission-file/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/upload-business-submission-file/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Upload a file requested by a successful business submission" } }, "/source-channels/{source_channel_id}/businesses/": { "post": { "description": "Fetch this channel's business-contract endpoint before constructing the request body. Matching Idempotency-Key retries replay the exact committed response for at least 24 hours.", "operationId": "createSourceChannelBusiness", "parameters": [ { "in": "path", "name": "source_channel_id", "required": true, "schema": { "pattern": "^srcch_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "application": {}, "business": { "name": "Northstar Foods Inc.", "primary_contact_email": "maya.chen@northstarfoods.example", "primary_contact_name": "Maya Chen" }, "meta": {} }, "schema": { "additionalProperties": true, "description": "The exact schema is returned by the source channel's business-contract endpoint.", "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessCreateResult" } } }, "description": "Business and client intake application created.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "400": { "content": { "application/json": { "example": { "error": { "code": "invalid_request", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-source-channel-business/", "message": "Correct the request fields and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "401": { "content": { "application/json": { "example": { "error": { "code": "invalid_api_key", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-source-channel-business/", "message": "Provide a valid API key and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "authentication_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "403": { "content": { "application/json": { "example": { "error": { "code": "permission_denied", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-source-channel-business/", "message": "This API key does not allow this action.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "permission_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "404": { "content": { "application/json": { "example": { "error": { "code": "not_found", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-source-channel-business/", "message": "The requested resource was not found.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "409": { "content": { "application/json": { "example": { "error": { "code": "conflict", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-source-channel-business/", "message": "The request conflicts with the current resource state.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "conflict_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "422": { "content": { "application/json": { "example": { "error": { "code": "validation_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-source-channel-business/", "message": "Correct the invalid values and try again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "invalid_request_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } }, "429": { "content": { "application/json": { "example": { "error": { "code": "rate_limited", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-source-channel-business/", "message": "Wait before sending another request.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "rate_limit_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "Retry-After": { "description": "Minimum seconds to wait before retrying.", "schema": { "minimum": 1, "type": "integer" } } } }, "500": { "content": { "application/json": { "example": { "error": { "code": "internal_error", "details": [], "documentation_url": "https://docs.levr.ai/rest-api-reference/businesses/create-source-channel-business/", "message": "Retry the request, then contact support if it fails again.", "request_id": "req_2m8q7c9k4x6p3n5d", "type": "api_error" } }, "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "details": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "pointer": { "type": "string" } }, "required": [ "pointer", "code", "message" ], "type": "object" }, "type": "array" }, "documentation_url": { "format": "uri", "type": "string" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" }, "type": { "enum": [ "api_error", "authentication_error", "conflict_error", "idempotency_error", "invalid_request_error", "permission_error", "rate_limit_error" ], "type": "string" } }, "required": [ "type", "code", "message", "details", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed.", "headers": { "RateLimit-Limit": { "description": "Maximum requests in the effective fixed quota window.", "schema": { "minimum": 1, "type": "integer" } }, "RateLimit-Remaining": { "description": "Requests remaining in the effective quota window.", "schema": { "minimum": 0, "type": "integer" } }, "RateLimit-Reset": { "description": "Seconds until the effective quota window resets.", "schema": { "minimum": 1, "type": "integer" } }, "Request-Id": { "description": "Server-generated request identifier for support and event correlation.", "schema": { "pattern": "^req_[a-z0-9]+$", "type": "string" } } } } }, "summary": "Create a business through an API source channel" } } }, "security": [ { "apiKey": [] } ], "servers": [ { "url": "https://api.levr.ai/v1" } ], "webhooks": { "business_created": { "post": { "description": "A Business became available in your Portal. It fires after Levr saves the Business in your Portal. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "business_created_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "created_at": "2026-08-19T16:42:13Z", "id": "biz_7fj3k9m2d8q4n6wx", "name": "Example Analytics Inc.", "object": "business" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "business.created" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "type": "string" }, "id": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" }, "object": { "const": "business", "type": "string" } }, "required": [ "id", "object", "name", "created_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "business.created", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Business created" } }, "business_status_changed": { "post": { "description": "A business moved to a different stage in the portal pipeline. It fires after Levr commits a change to the business's stage in this provider's business pipeline. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "business_status_changed_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "id": "biz_7fj3k9m2d8q4n6wx", "name": "Example Analytics Inc.", "object": "business", "status": { "changed_at": "2026-08-19T16:42:13Z", "pipeline": "Clients", "stage": "Underwriting" } } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "business.status_changed" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "id": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" }, "object": { "const": "business", "type": "string" }, "status": { "additionalProperties": false, "properties": { "changed_at": { "format": "date-time", "type": "string" }, "pipeline": { "type": "string" }, "stage": { "type": "string" } }, "required": [ "pipeline", "stage", "changed_at" ], "type": "object" } }, "required": [ "id", "object", "name", "status" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "business.status_changed", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Business status changed" } }, "business_updated": { "post": { "description": "Business information in your Portal changed. It fires after Levr saves a change to the Business name or referral information in your Portal. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "business_updated_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "id": "biz_7fj3k9m2d8q4n6wx", "name": "Example Analytics — Growth", "object": "business", "revision": 4, "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "business.updated" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "id": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" }, "object": { "const": "business", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "name", "revision", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "business.updated", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Business updated" } }, "client_intake_application_autofill_run_settled": { "post": { "description": "A Client Intake Application autofill Run completed or failed. It fires after Levr commits the terminal outcome of an asynchronous autofill Run. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "client_intake_application_autofill_run_settled_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "application": "ciappl_7fj3k9m2d8q4n6wx", "can_retry": true, "id": "afrun_7fj3k9m2d8q4n6wx", "object": "client_intake_application_autofill_run", "status": "completed", "suggestion_count": 14, "updated_at": "2026-08-19T16:42:13Z", "warning_count": 1 } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "client_intake_application_autofill_run.settled" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "application": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" }, "can_retry": { "type": "boolean" }, "id": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" }, "object": { "const": "client_intake_application_autofill_run", "type": "string" }, "status": { "enum": [ "completed", "failed" ], "type": "string" }, "suggestion_count": { "minimum": 0, "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "warning_count": { "minimum": 0, "type": "integer" } }, "required": [ "id", "object", "application", "status", "suggestion_count", "warning_count", "can_retry", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "client_intake_application_autofill_run.settled", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Client Intake Application autofill settled" } }, "client_intake_application_created": { "post": { "description": "A Client Intake Application became available in your Portal. It fires after Levr commits the shared Client Intake Application. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "client_intake_application_created_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "answers_revision": 0, "business": "biz_2m8q7c9k4x6p3n5d", "id": "ciappl_7fj3k9m2d8q4n6wx", "object": "client_intake_application", "revision": 0, "status": "pre_submitted", "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "client_intake_application.created" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": [ "integer", "null" ] }, "business": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "id": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" }, "object": { "const": "client_intake_application", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "status": { "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "business", "revision", "answers_revision", "status", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "client_intake_application.created", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Client Intake Application created" } }, "client_intake_application_status_changed": { "post": { "description": "The lifecycle status of a Client Intake Application changed. It fires after Levr commits a Client Intake Application status transition, including submission. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "client_intake_application_status_changed_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "answers_revision": 0, "business": "biz_2m8q7c9k4x6p3n5d", "id": "ciappl_7fj3k9m2d8q4n6wx", "object": "client_intake_application", "revision": 0, "status": "action_required", "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "client_intake_application.status_changed" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": [ "integer", "null" ] }, "business": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "id": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" }, "object": { "const": "client_intake_application", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "status": { "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "business", "revision", "answers_revision", "status", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "client_intake_application.status_changed", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Client Intake Application status changed" } }, "client_intake_application_submitted": { "post": { "description": "A Client Intake Application was submitted. It fires after Levr commits a successful Client Intake Application submission. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "client_intake_application_submitted_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "answers_revision": 0, "business": "biz_2m8q7c9k4x6p3n5d", "id": "ciappl_7fj3k9m2d8q4n6wx", "object": "client_intake_application", "revision": 0, "status": "submitted", "submitted_at": "2026-08-19T16:42:13Z", "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "client_intake_application.submitted" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": [ "integer", "null" ] }, "business": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "id": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" }, "object": { "const": "client_intake_application", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "status": { "type": [ "string", "null" ] }, "submitted_at": { "format": "date-time", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "business", "revision", "answers_revision", "status", "updated_at", "submitted_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "client_intake_application.submitted", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Client Intake Application submitted" } }, "client_intake_application_updated": { "post": { "description": "The shared answers of a Client Intake Application changed. It fires after Levr saves a change to the Client Intake Application answers. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "client_intake_application_updated_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "answers_revision": 3, "business": "biz_2m8q7c9k4x6p3n5d", "id": "ciappl_7fj3k9m2d8q4n6wx", "object": "client_intake_application", "revision": 0, "status": "pre_submitted", "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "client_intake_application.updated" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": [ "integer", "null" ] }, "business": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "id": { "pattern": "^ciappl_[a-z0-9]+$", "type": "string" }, "object": { "const": "client_intake_application", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "status": { "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "business", "revision", "answers_revision", "status", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "client_intake_application.updated", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Client Intake Application updated" } }, "deal_application_autofill_run_settled": { "post": { "description": "A Deal Application autofill Run completed or failed. It fires after Levr commits the terminal outcome of an asynchronous autofill Run. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "deal_application_autofill_run_settled_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "application": "dapp_4m8q7c9k2x6p3n5d", "can_retry": true, "id": "afrun_7fj3k9m2d8q4n6wx", "object": "deal_application_autofill_run", "status": "completed", "suggestion_count": 14, "updated_at": "2026-08-19T16:42:13Z", "warning_count": 1 } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "deal_application_autofill_run.settled" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "application": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "can_retry": { "type": "boolean" }, "id": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" }, "object": { "const": "deal_application_autofill_run", "type": "string" }, "status": { "enum": [ "completed", "failed" ], "type": "string" }, "suggestion_count": { "minimum": 0, "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "warning_count": { "minimum": 0, "type": "integer" } }, "required": [ "id", "object", "application", "status", "suggestion_count", "warning_count", "can_retry", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "deal_application_autofill_run.settled", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Deal Application autofill settled" } }, "deal_application_created": { "post": { "description": "A Deal Application became available in your Portal. It fires after Levr grants your Portal access to the Deal Application. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "deal_application_created_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "answers_revision": 0, "id": "dapp_7fj3k9m2d8q4n6wx", "object": "deal_application", "revision": 0, "status": "is_pre_submitted", "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "deal_application.created" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "id": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "object": { "const": "deal_application", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "status": { "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "revision", "answers_revision", "status", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "deal_application.created", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Deal Application created" } }, "deal_application_status_changed": { "post": { "description": "The status of a Deal Application available in your Portal changed. It fires after Levr commits one Deal Application status transition. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "deal_application_status_changed_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "answers_revision": 7, "id": "dapp_7fj3k9m2d8q4n6wx", "object": "deal_application", "revision": 5, "status": "is_declined", "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "deal_application.status_changed" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "id": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "object": { "const": "deal_application", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "status": { "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "revision", "answers_revision", "status", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "deal_application.status_changed", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Deal Application status changed" } }, "deal_application_submitted": { "post": { "description": "A Deal Application available in your Portal was submitted. It fires after Levr commits the shared Deal Application submission. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "deal_application_submitted_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "answers_revision": 7, "id": "dapp_7fj3k9m2d8q4n6wx", "object": "deal_application", "revision": 4, "status": "submitted", "submitted_at": "2026-08-19T16:42:13Z", "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "deal_application.submitted" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "id": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "object": { "const": "deal_application", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "status": { "type": [ "string", "null" ] }, "submitted_at": { "format": "date-time", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "revision", "answers_revision", "status", "submitted_at", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "deal_application.submitted", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Deal Application submitted" } }, "deal_application_updated": { "post": { "description": "The answers of a Deal Application available in your Portal changed. It fires after Levr saves a change to the Deal Application answers. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "deal_application_updated_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "answers_revision": 7, "id": "dapp_7fj3k9m2d8q4n6wx", "object": "deal_application", "revision": 4, "status": "is_pre_submitted", "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "deal_application.updated" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": "integer" }, "id": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "object": { "const": "deal_application", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "status": { "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "revision", "answers_revision", "status", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "deal_application.updated", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Deal Application updated" } }, "deal_created": { "post": { "description": "A Deal was created in your Portal, with or without a linked Project. It fires after Levr saves the new Deal. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "deal_created_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "application": "dapp_4m8q7c9k2x6p3n5d", "id": "deal_7fj3k9m2d8q4n6wx", "name": "Northstar Foods — Growth Financing", "object": "deal", "project": "proj_2m8q7c9k4x6p3n5d", "revision": 3, "status": "is_pre_submitted", "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "deal.created" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "application": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "id": { "pattern": "^deal_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" }, "object": { "const": "deal", "type": "string" }, "project": { "anyOf": [ { "pattern": "^proj_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] }, "revision": { "minimum": 0, "type": "integer" }, "status": { "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "name", "revision", "application", "project", "status", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "deal.created", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Deal created" } }, "deal_stage_changed": { "post": { "description": "A Deal moved to another pipeline stage in your Portal. It fires after Levr saves the Deal's new pipeline stage. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "deal_stage_changed_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "application": "dapp_4m8q7c9k2x6p3n5d", "id": "deal_7fj3k9m2d8q4n6wx", "name": "Northstar Foods — Growth Financing", "object": "deal", "project": "proj_2m8q7c9k4x6p3n5d", "revision": 3, "stage": "Underwriting", "status": "is_pre_submitted", "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "deal.stage_changed" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "application": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "id": { "pattern": "^deal_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" }, "object": { "const": "deal", "type": "string" }, "project": { "anyOf": [ { "pattern": "^proj_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] }, "revision": { "minimum": 0, "type": "integer" }, "stage": { "type": "string" }, "status": { "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "name", "revision", "application", "project", "status", "updated_at", "stage" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "deal.stage_changed", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Deal stage changed" } }, "deal_updated": { "post": { "description": "A Deal's details, linked Project, or application status changed. It fires after Levr commits a Deal edit, Project association, or shared application lifecycle change. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "deal_updated_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "application": "dapp_4m8q7c9k2x6p3n5d", "id": "deal_7fj3k9m2d8q4n6wx", "name": "Northstar Foods — Growth Financing", "object": "deal", "project": "proj_2m8q7c9k4x6p3n5d", "revision": 3, "status": "is_declined", "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "deal.updated" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "application": { "pattern": "^dapp_[a-z0-9]+$", "type": "string" }, "id": { "pattern": "^deal_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" }, "object": { "const": "deal", "type": "string" }, "project": { "anyOf": [ { "pattern": "^proj_[a-z0-9]+$", "type": "string" }, { "type": "null" } ] }, "revision": { "minimum": 0, "type": "integer" }, "status": { "type": [ "string", "null" ] }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "name", "revision", "application", "project", "status", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "deal.updated", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Deal updated" } }, "project_created": { "post": { "description": "A Project was created in your Portal. It fires after Levr saves the new Project. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "project_created_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "answers_revision": 0, "business": "biz_2m8q7c9k4x6p3n5d", "id": "proj_7fj3k9m2d8q4n6wx", "object": "project", "revision": 0, "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "project.created" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": [ "integer", "null" ] }, "business": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "id": { "pattern": "^proj_[a-z0-9]+$", "type": "string" }, "object": { "const": "project", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "business", "revision", "answers_revision", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "project.created", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Project created" } }, "project_matchmaking_application_autofill_run_settled": { "post": { "description": "Autofill for a Project's Criteria completed or failed. It fires after Levr commits the terminal outcome of an asynchronous autofill Run. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "project_matchmaking_application_autofill_run_settled_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "can_retry": true, "id": "afrun_7fj3k9m2d8q4n6wx", "object": "project_matchmaking_application_autofill_run", "project": "proj_2m8q7c9k4x6p3n5d", "status": "completed", "suggestion_count": 14, "updated_at": "2026-08-19T16:42:13Z", "warning_count": 1 } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "project_matchmaking_application_autofill_run.settled" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "can_retry": { "type": "boolean" }, "id": { "pattern": "^afrun_[a-z0-9]+$", "type": "string" }, "object": { "const": "project_matchmaking_application_autofill_run", "type": "string" }, "project": { "pattern": "^proj_[a-z0-9]+$", "type": "string" }, "status": { "enum": [ "completed", "failed" ], "type": "string" }, "suggestion_count": { "minimum": 0, "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "warning_count": { "minimum": 0, "type": "integer" } }, "required": [ "id", "object", "project", "status", "suggestion_count", "warning_count", "can_retry", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "project_matchmaking_application_autofill_run.settled", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Project Criteria Autofill settled" } }, "project_matchmaking_run_status_changed": { "post": { "description": "A Project Matchmaking Run reached a settled status. It fires after a calculation settles as partially complete, completed, failed, or cancelled. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "project_matchmaking_run_status_changed_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "id": "pmrun_7fj3k9m2d8q4n6wx", "object": "project_matchmaking_run", "project": "proj_2m8q7c9k4x6p3n5d", "status": "completed", "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "project_matchmaking_run.status_changed" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "id": { "pattern": "^pmrun_[a-z0-9]+$", "type": "string" }, "object": { "const": "project_matchmaking_run", "type": "string" }, "project": { "pattern": "^proj_[a-z0-9]+$", "type": "string" }, "status": { "enum": [ "partially_complete", "completed", "failed", "cancelled" ], "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "project", "status", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "project_matchmaking_run.status_changed", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Project match calculation status changed" } }, "project_stage_changed": { "post": { "description": "A Project moved to a different pipeline stage in your Portal. It fires after Levr commits one Project stage transition. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "project_stage_changed_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "answers_revision": 0, "business": "biz_2m8q7c9k4x6p3n5d", "id": "proj_7fj3k9m2d8q4n6wx", "object": "project", "revision": 0, "stage": "In progress", "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "project.stage_changed" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": [ "integer", "null" ] }, "business": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "id": { "pattern": "^proj_[a-z0-9]+$", "type": "string" }, "object": { "const": "project", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "stage": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "business", "revision", "stage", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "project.stage_changed", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Project stage changed" } }, "project_updated": { "post": { "description": "A Project's details or Criteria changed. It fires after Levr saves a change to the Project or its Criteria answers. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "project_updated_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "object": { "answers_revision": 0, "business": "biz_2m8q7c9k4x6p3n5d", "id": "proj_7fj3k9m2d8q4n6wx", "object": "project", "revision": 0, "updated_at": "2026-08-19T16:42:13Z" } }, "id": "evt_2m8q7c9k4x6p3n5d", "object": "event", "request": { "id": "req_2m8q7c9k4x6p3n5d" }, "test_mode": false, "type": "project.updated" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "object": { "additionalProperties": false, "properties": { "answers_revision": { "minimum": 0, "type": [ "integer", "null" ] }, "business": { "pattern": "^biz_[a-z0-9]+$", "type": "string" }, "id": { "pattern": "^proj_[a-z0-9]+$", "type": "string" }, "object": { "const": "project", "type": "string" }, "revision": { "minimum": 0, "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "object", "business", "revision", "answers_revision", "updated_at" ], "type": "object" } }, "required": [ "object" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "object": { "const": "event", "type": "string" }, "request": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "id" ], "type": "object" }, { "type": "null" } ] }, "test_mode": { "type": "boolean" }, "type": { "const": "project.updated", "type": "string" } }, "required": [ "id", "object", "type", "api_version", "created_at", "test_mode", "request", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Project updated" } } }, "x-levr-documentation-url": "https://docs.levr.ai/rest-api-reference/" }