Get

GET

https://api.phonic.ai/v1/extraction_schemas/:nameOrId

GET

/v1/extraction_schemas/:nameOrId

from phonic import Phonic
client = Phonic(
    api_key="YOUR_TOKEN_HERE",
)
client.extraction_schemas.get(
    name_or_id="nameOrId",
    project="main",
)

{
  "extraction_schema": {
    "id": "conv_extract_schema_c818e617-59f9-4f43-936e-ca8a794f9ccf",
    "name": "Appointment details",
    "prompt": "Dates should be in `9 Apr 2025` format. Prices should be in $150.00 format.",
    "fields": [
      {
        "name": "Date",
        "type": "string",
        "description": "The date of the appointment"
      },
      {
        "name": "Copay",
        "type": "string",
        "description": "Amount of money the patient pays for the appointment"
      },
      {
        "name": "Confirmed as booked",
        "type": "bool",
        "description": "Is the appointment confirmed as booked?"
      }
    ]
  }
}

Returns an extraction schema by name or ID.

Authentication

AuthorizationBearer

Bearer authentication header of the form Bearer <PHONIC_API_KEY>. Manage your API keys here.

Path parameters

nameOrIdstringRequired

The name or the ID of the extraction schema to get.

Query parameters

projectstringOptionalDefaults to main

The name of the project containing the extraction schema. Only used when nameOrId is a name.

Response

Success response

extraction_schemaobject

Errors

404

Not Found Error