Skip to main content
GET
/
api
/
v1
/
schemas
/
id
/
{schema_id}
Get Schema by ID
curl --request GET \
  --url https://api.invaro.ai/api/v1/api/v1/schemas/id/{schema_id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "id": "b3376c85-86e0-476e-aee9-5f05afaa05ea",
    "user_id": "b4825725-605b-4374-a64e-c40896b5a0e8",
    "name": "invoice_schema_v1",
    "type": "invoice",
    "description": "Schema for parsing standard invoices",
    "schema_string": "{\"fields\": [...]} Gzip Base64 format",
    "version": 1,
    "is_active": true,
    "created_at": "2024-01-18T12:34:56Z",
    "updated_at": "2024-01-18T12:34:56Z"
  }
}

​
Path Parameters

​
schema_id
string
required
The unique identifier of the schema.

​
Response

Success Response (200)
{
  "success": true,
  "data": {
    "id": "b3376c85-86e0-476e-aee9-5f05afaa05ea",
    "name": "invoice_schema_v1",
    "type": "invoice",
    "description": "Schema for parsing standard invoices",
    "schema_string": "{\"fields\": [...]}",
    "version": 1,
    "is_active": true,
    "created_at": "2024-01-18T12:34:56Z",
    "updated_at": "2024-01-18T12:34:56Z"
  }
}

​
Examples

​
Get a Specific Schema

Curl
curl "https://api.invaro.ai/api/v1/schemas/id/b3376c85-86e0-476e-aee9-5f05afaa05ea" \
  -H "Authorization: Bearer your_api_key"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
schema_id
string<uuid>
required

The unique identifier of the schema.

Response

200 - application/json

Schema retrieved successfully

​
success
boolean
Example:

true

​
data
object
⌘I