List

GET

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

GET

/v1/extraction_schemas

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

{
  "extraction_schemas": [
    {
      "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 all extraction schemas in a project.

Authentication

AuthorizationBearer

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

Query parameters

projectstringOptionalDefaults to main

The name of the project to list extraction schemas for.

Response

Success response

extraction_schemaslist of objects

Errors

404

Not Found Error