Skip to content

spec-sync: track V1 spec drift #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
yzld2002 wants to merge 1 commit into from
Closed

spec-sync: track V1 spec drift #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
188 changes: 188 additions & 0 deletions specs/v1-ade.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2329,6 +2329,194 @@
]
}
},
"/v1/ade/extract/jobs": {
"get": {
"description": "List all async extract jobs associated with your API key.\n\nReturns the list of jobs or an error response. For EU users, use this endpoint:\n\n`https://api.va.eu-west-1.landing.ai/v1/ade/extract/jobs`.",
"operationId": "tool_ade_list_extract_jobs_v1_ade_extract_jobs_get",
"parameters": [
{
"description": "Page number (0-indexed)",
"in": "query",
"name": "page",
"required": false,
"schema": {
"default": 0,
"description": "Page number (0-indexed)",
"minimum": 0,
"title": "Page",
"type": "integer"
}
},
{
"description": "Number of items per page",
"in": "query",
"name": "pageSize",
"required": false,
"schema": {
"default": 10,
"description": "Number of items per page",
"maximum": 100,
"minimum": 1,
"title": "Pagesize",
"type": "integer"
}
},
{
"description": "Filter by job status.",
"in": "query",
"name": "status",
"required": false,
"schema": {
"anyOf": [
{
"enum": [
"cancelled",
"completed",
"failed",
"pending",
"processing"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Filter by job status.",
"title": "Status"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JobsListResponse"
}
}
},
"description": "Successful Response"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "ADE List Extract Jobs",
"tags": [
"Tools"
]
},
"post": {
"description": "Extract structured data asynchronously.\n\nThis endpoint creates a job that handles the processing for large markdown\ndocuments.\n\nFor EU users, use this endpoint:\n\n`https://api.va.eu-west-1.landing.ai/v1/ade/extract/jobs`.",
"operationId": "tool_ade_extract_jobs_v1_ade_extract_jobs_post",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/AsyncExtractRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/json": {
"example": {
"job_id": "12345678-1234-1234-1234-123456789012"
},
"schema": {
"$ref": "#/components/schemas/JobCreationResponse"
}
}
},
"description": "Job queued successfully"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
},
"429": {
"description": "Rate limit exceeded"
}
},
"summary": "ADE Extract Jobs",
"tags": [
"Tools"
]
}
},
"/v1/ade/extract/jobs/{job_id}": {
"get": {
"description": "Get the status for an async extract job.\n\nReturns the job status or an error\n response. For EU users, use this endpoint:\n\n\n `https://api.va.eu-west-1.landing.ai/v1/ade/extract/jobs/{job_id}`.",
"operationId": "tool_ade_get_extract_jobs_v1_ade_extract_jobs__job_id__get",
"parameters": [
{
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"title": "Job Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtractJobStatusResponse"
}
}
},
"description": "Successful Response"
},
"206": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExtractJobStatusResponse"
}
}
},
"description": "Extraction completed with success but there was a schema validation error."
},
"404": {
"description": "Job ID not found"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
},
"description": "Validation Error"
}
},
"summary": "ADE Get Extract Jobs",
"tags": [
"Tools"
]
}
},
"/v1/ade/parse": {
"post": {
"description": "Parse a document or spreadsheet.\n\nThis endpoint parses documents (PDF, images)\n and spreadsheets (XLSX, CSV) into structured Markdown, chunks, and metadata.\n \n\n For EU users, use this endpoint:\n\n\n `https://api.va.eu-west-1.landing.ai/v1/ade/parse`.",
Expand Down