Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

File Definition Rules

Submit an EDI specification PDF (X12 or EDIFACT) and receive parsing and/or generation File Definition Rules JSON, generated asynchronously. Submit endpoints return a requestId immediately (202); poll the matching GET endpoint until the job reaches completed or failed. Job records expire 24 hours after submission. Submissions are rate-limited per caller (10 per hour, with an administrator bypass); the document-types catalog allows 100 per hour and 10 per 60 seconds. The API only produces rules — it persists nothing. The Ora agent in integrator.io drives these endpoints for interactive onboarding; call them directly to script partner onboarding in bulk.

File definition rules schemas

Submit an FDR generation job

post
/v1/filedefinitionrules/generate

Submits an async job that produces both parsing and generation FDR artifacts from the supplied EDI specification PDF. Returns a requestId immediately; poll GET /v1/filedefinitionrules/generate/{requestId} for status and results. Rate-limited to 10 submissions per caller per hour (administrators bypass the limit).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
pdfstringRequired

Base64-encoded EDI specification PDF. Must decode to a text-bearing PDF — scanned/image-only documents fail the job with PDF_EXTRACTION_FAILED. Encoded payloads over 50 MB are rejected with 413 PAYLOAD_TOO_LARGE.

documentTypeintegerRequired

X12 transaction set number (e.g. 850), or 0 to auto-detect an EDIFACT specification from the PDF contents. Values outside the supported set fail with 400 INVALID_DOCUMENT_TYPE; discover the supported set via GET /v1/filedefinitionrules/document-types.

Example: 850
Responses
202

Job accepted.

application/json
post/v1/filedefinitionrules/generate
POST /v1/filedefinitionrules/generate HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "pdf": "<base64-encoded PDF>",
  "documentType": 850
}
{
  "fileDefinitionGenerationJob": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Poll an FDR generation job

get
/v1/filedefinitionrules/generate/{requestId}

Returns the job's current state. When status is completed, result carries parsingFdr and generationFdr; when failed, error carries the code and message. Non-administrators can only poll their own jobs. Job records expire after 24 hours (404 REQUEST_NOT_FOUND).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
requestIdstring · uuidRequired

Request id returned by the submit endpoint.

Example: 550e8400-e29b-41d4-a716-446655440000
Responses
200

Current job state.

application/json
get/v1/filedefinitionrules/generate/{requestId}
GET /v1/filedefinitionrules/generate/{requestId} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "fileDefinitionGenerationJob": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "status": "completed",
    "createdAt": "2026-06-24T10:30:00Z",
    "startedAt": "2026-06-24T10:30:05Z",
    "completedAt": "2026-06-24T10:31:45Z",
    "result": {
      "parsingFdr": {},
      "generationFdr": {}
    }
  }
}

Submit an FDR parsing job

post
/v1/filedefinitionrules/parse

Submits an async job that produces a parsing FDR only (no generation artifact) from the supplied EDI specification PDF. Returns a requestId immediately; poll GET /v1/filedefinitionrules/parse/{requestId} for status and results. Rate-limited to 10 submissions per caller per hour (administrators bypass the limit).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
pdfstringRequired

Base64-encoded EDI specification PDF. Must decode to a text-bearing PDF — scanned/image-only documents fail the job with PDF_EXTRACTION_FAILED. Encoded payloads over 50 MB are rejected with 413 PAYLOAD_TOO_LARGE.

documentTypeintegerRequired

X12 transaction set number (e.g. 850), or 0 to auto-detect an EDIFACT specification from the PDF contents. Values outside the supported set fail with 400 INVALID_DOCUMENT_TYPE; discover the supported set via GET /v1/filedefinitionrules/document-types.

Example: 850
Responses
202

Job accepted.

application/json
post/v1/filedefinitionrules/parse
POST /v1/filedefinitionrules/parse HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "pdf": "<base64-encoded PDF>",
  "documentType": 850
}
{
  "fileDefinitionParsingJob": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Poll an FDR parsing job

get
/v1/filedefinitionrules/parse/{requestId}

Returns the job's current state. When status is completed, result carries parsingFdr only; when failed, error carries the code and message. Non-administrators can only poll their own jobs. Job records expire after 24 hours (404 REQUEST_NOT_FOUND).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
requestIdstring · uuidRequired

Request id returned by the submit endpoint.

Example: 550e8400-e29b-41d4-a716-446655440000
Responses
200

Current job state.

application/json
get/v1/filedefinitionrules/parse/{requestId}
GET /v1/filedefinitionrules/parse/{requestId} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "fileDefinitionParsingJob": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "status": "completed",
    "createdAt": "2026-06-24T10:30:00Z",
    "completedAt": "2026-06-24T10:31:45Z",
    "result": {
      "parsingFdr": {}
    }
  }
}

List supported document types

get
/v1/filedefinitionrules/document-types

Returns the X12 transaction set numbers the generator supports (24 sets as of v1.2.0) and whether EDIFACT auto-detection is available (documentType: 0). Rate-limited to 100 requests per hour and 10 per 60 seconds per caller.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Supported document types.

application/json
get/v1/filedefinitionrules/document-types
GET /v1/filedefinitionrules/document-types HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "fileDefinitionDocumentTypes": {
    "supportedTypes": [
      180,
      204,
      210,
      214,
      810,
      812,
      820,
      824,
      832,
      835,
      846,
      850,
      852,
      855,
      856,
      860,
      864,
      870,
      875,
      880,
      940,
      943,
      944,
      945
    ],
    "edifactSupported": true
  }
}
PreviousEDI Transactions
NextFile Definitions

Last updated

Was this helpful?