Create Config

curl --request POST \
  --url https://extraction-api.nanonets.com/api/v2/configs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "markdown-parser",
  "type": "parse",
  "params": {
    "output_format": "markdown",
    "custom_instructions": "Format dates as YYYY-MM-DD"
  }
}
'

{
  "success": true,
  "config_id": "config://b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "name": "<string>",
  "params": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

api

configs

curl --request POST \
  --url https://extraction-api.nanonets.com/api/v2/configs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "markdown-parser",
  "type": "parse",
  "params": {
    "output_format": "markdown",
    "custom_instructions": "Format dates as YYYY-MM-DD"
  }
}
'

{
  "success": true,
  "config_id": "config://b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "name": "<string>",
  "params": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

API key as Bearer token: Authorization: Bearer YOUR_API_KEY

Body

application/json

name

string

required

Human-readable config name

Required string length: 1 - 255

type

enum<string>

required

Config type

Available options:

parse,

extract,

classify

params

object

required

Configuration parameters (varies by type)

Response

Config created

success

boolean

required

config_id

string

required

config://<uuid> URI

Example:

"config://b2c3d4e5-f6a7-8901-bcde-f12345678901"

name

string

required

type

enum<string>

required

Available options:

parse,

extract,

classify

params

object

required

created_at

string<date-time>

updated_at

string<date-time>

Batch Classification List Configs

⌘I

File Upload

Document Parsing

Document Extraction

Document Classification

Configuration Management

Authorizations

Body

Response