List

GET

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

GET

/v1/extraction_schemas

1 from phonic import Phonic
2 
3 client = Phonic(
4     base_url="https://api.phonic.co/v1",
5     api_key="YOUR_TOKEN_HERE"
6 )
7 
8 client.extraction_schemas.list(
9     project="main"
10 )

Try it

200Retrieved

1 {
2   "extraction_schemas": [
3     {
4       "id": "conv_extract_schema_c818e617-59f9-4f43-936e-ca8a794f9ccf",
5       "name": "Appointment details",
6       "prompt": "Dates should be in `9 Apr 2025` format. Prices should be in $150.00 format.",
7       "fields": [
8         {
9           "name": "Date",
10           "type": "string",
11           "description": "The date of the appointment"
12         },
13         {
14           "name": "Copay",
15           "type": "string",
16           "description": "Amount of money the patient pays for the appointment"
17         },
18         {
19           "name": "Confirmed as booked",
20           "type": "bool",
21           "description": "Is the appointment confirmed as booked?"
22         }
23       ]
24     }
25   ]
26 }

Returns all extraction schemas in a project.

Authentication

AuthorizationBearer

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

Bearer authentication header of the form `Bearer <PHONIC_API_KEY>`. Manage your API keys [here](https://phonic.co/api-keys).

Query parameters

projectstringOptionalDefaults to main

The name of the project to list extraction schemas for.

Response

Success response

extraction_schemaslist of objects

Authentication

Query parameters

Response

Errors