Check Schema Generation Status

curl -X GET https://api.appliedai.club/api/extractor/v1/generate-schema-status/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: YOUR_API_KEY"

import requests

url = "https://api.appliedai.club/api/extractor/v1/generate-schema-status/550e8400-e29b-41d4-a716-446655440000"
headers = {
    "Authorization": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
result = response.json()
print(result)

{
  "task_id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "total_files": 1,
  "processed_files": 0,
  "failed_files": 0,
  "results": {},
  "errors": "<string>"
}

{
  "detail": "<string>",
  "error_code": "unauthorized"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {}
  ]
}

{
  "detail": "<string>",
  "retry_after": 123
}

{
  "detail": "<string>"
}

GET

api

extractor

generate-schema-status

{task_id}

curl -X GET https://api.appliedai.club/api/extractor/v1/generate-schema-status/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: YOUR_API_KEY"

import requests

url = "https://api.appliedai.club/api/extractor/v1/generate-schema-status/550e8400-e29b-41d4-a716-446655440000"
headers = {
    "Authorization": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
result = response.json()
print(result)

{
  "task_id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "total_files": 1,
  "processed_files": 0,
  "failed_files": 0,
  "results": {},
  "errors": "<string>"
}

{
  "detail": "<string>",
  "error_code": "unauthorized"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {}
  ]
}

{
  "detail": "<string>",
  "retry_after": 123
}

{
  "detail": "<string>"
}

This API requires authentication. See our Authentication Guide for details.

Path Parameters

task_id

string

required

UUID of the schema generation task

Status Values

PROCESSING: Task is currently being processed
COMPLETED: Task has completed successfully
FAILED: Task has failed

When status is COMPLETED, the response will include the schema generation results. When status is FAILED, the response will include error information.

curl -X GET https://api.appliedai.club/api/extractor/v1/generate-schema-status/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: YOUR_API_KEY"

import requests

url = "https://api.appliedai.club/api/extractor/v1/generate-schema-status/550e8400-e29b-41d4-a716-446655440000"
headers = {
    "Authorization": "YOUR_API_KEY"
}

response = requests.get(url, headers=headers)
result = response.json()
print(result)

Authorizations

Authorization

string

header

required

Enter your API key

Path Parameters

task_id

string

required

UUID of the schema generation task

Response

Successful Response

Response model for extraction status check

task_id

string

required

status

enum<string>

required

Available options:

processing,

retrying,

completed,

failed

created_at

string

required

updated_at

string

required

total_files

integer

default:1

processed_files

integer

default:0

failed_files

integer

default:0

results

Results · object | null

errors

string | null

Generate Schema Asynchronously Customer Service QA

Getting Started

Common Features

User Research

Image Extraction

Freshdesk Quality Assistant

Check Schema Generation Status

Path Parameters

Status Values

Authorizations

Path Parameters

Response

​Path Parameters

​Status Values

Authorizations

Path Parameters

Response

Path Parameters

Status Values