Skip to content
Docs
Follow yggy on LinkedInFollow @yggy_tech on X

Get extraction mapping for a document

GET
/api/v1/documents/{id}/mapping
 
curl --request GET \
  --url https://api.yggy.tech/api/v1/documents/example/mapping \
  --header 'Authorization: Bearer <token>'

Retrieve the extraction mapping used for a structured document. Returns 404 if the document has no mapping (for example an unstructured document).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Header Parameters

Section titled “Header Parameters ”
host
string | null
x-yggy-organization-id
string | null

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Extraction mapping

Media type application/json
object
id
required
string
externalId
required
string | null
name
required
string | null
format
required
string
mapping
required
object
key
additional properties
schemaHeaders
required
Array<string>
literalAssertions
required
Array<object>
object
key
additional properties
sourceRecords
required
Array<object>
object
key
additional properties
createdAt
required
string | null
updatedAt
required
string | null
Example generated
{
  "id": "example",
  "externalId": "example",
  "name": "example",
  "format": "example",
  "mapping": {
    "additionalProperty": "example"
  },
  "schemaHeaders": [
    "example"
  ],
  "literalAssertions": [
    {
      "additionalProperty": "example"
    }
  ],
  "sourceRecords": [
    {
      "additionalProperty": "example"
    }
  ],
  "createdAt": "example",
  "updatedAt": "example"
}

404

Section titled “404 ”

No mapping found

Media type application/json
object
success
required
boolean
error
required
object
message
required
string
code
required
string
Allowed values: INTERNAL_ERROR VALIDATION_ERROR UNAUTHORIZED RATE_LIMITED ORG_REQUIRED FORBIDDEN NOT_FOUND CONFLICT PROJECT_DENIED USAGE_LIMIT_EXCEEDED HUGINN_ERROR HUGINN_STREAM_ERROR QUERY_FAILED PROVIDER_CONFLICT PROVIDER_CONFIG_INVALID PROVIDER_NOT_CONNECTED PROVIDER_RATE_LIMITED PROJECT_MEMBER_USER_NOT_IN_ORG PROJECT_MEMBER_UNKNOWN_ROLE PROJECT_MEMBER_LAST_OWNER PROJECT_CONFLICT STORAGE_NOT_CONFIGURED BILLING_NOT_CONFIGURED LICENSE_INACTIVE PLAN_REQUIRED MEMBER_LIMIT_REACHED SAGA_ASK_QUOTA_EXCEEDED SAGA_ASK_RATE_LIMITED SAGA_ASK_BUSY SAGA_ASK_PAUSED SAGA_ASK_UPSTREAM SAGA_DICTATION_BUSY SAGA_DICTATION_UNAVAILABLE SAGA_SHARE_LINK_LIMIT PROJECT_MEMBERSHIP_JWT_TOO_LARGE WEBHOOK_URL_INVALID WEBHOOK_ADDRESS_BLOCKED WEBHOOK_EVENT_UNKNOWN WEBHOOK_ENDPOINT_LIMIT WEBHOOK_ENDPOINT_DISABLED WEBHOOK_DELIVERY_IN_PROGRESS ORG_KEY_PERSONAL_SCOPE API_KEY_PERMISSION_EXCEEDS_ROLE API_KEY_NO_PERMISSIONS ORG_KEY_GRAPH_SCOPE_UNAVAILABLE ORG_KEY_TOO_MANY_PROJECTS SENDER_IS_LOGIN_EMAIL SENDER_TAKEN
details
Example 
{
  "success": false,
  "error": {
    "code": "INTERNAL_ERROR"
  }
}