Alfred

https://docs.tagshelf.dev
Admin
Alfred is an Intelligent Process Automation platform that extracts and analyzes data from any...
Tokens:30,257
Snippets:130
Trust Score:3.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example JSON Event Payload for Job Start

Source: https://docs.tagshelf.dev/event-api/jobevents/job-start

Provides a concrete example of a JSON event payload, populating the defined schema with sample values. This specific example illustrates a 'job_start_event', showing how UUIDs, timestamps, and ISO 8601 dates are formatted within the payload structure.

```json
{
  "event_id": "d2e3f4g5-h6i7-j8k9-l0m1-n2o3p4q5r6s7",
  "event_type": "job_event_type",
  "event_time": "1653645300.00",
  "event": {
    "event_name": "job_start_event",
    "event_type": "job_event_type",
    "company_id": "67890123-4567-4567-4567-456789012ghi",
    "company_name": "Innovate Logistics",
    "job_id": "78901234-5678-5678-5678-567890123jkl",
    "creation_date": "2023-05-26T23:20:00Z",
    "update_date": "2023-05-27T00:50:00Z"
  }
}
```

--------------------------------

### Example JSON Payload for a File Event

Source: https://docs.tagshelf.dev/event-api/fileevents/add-to-job

Provides a concrete example of an event payload, demonstrating typical values for event, company, file, and job identifiers and names. This snippet illustrates how the defined structure is populated with actual data.

```json
{
  "event_id": "e0f8b2e6-c1c9-4b34-8e5f-a10b7b760e75",
  "event_type": "file_event_type",
  "event_time": "1651018865.75",
  "event": {
    "event_name": "file_added_to_job_event",
    "event_type": "file_event_type",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "company_name": "Example Company",
    "file_id": "123e4567-e89b-12d3-a456-426614174001",
    "job_id": "123e4567-e89b-12d3-a456-426614174002"
  }
}
```

--------------------------------

### Example JSON Event Payload

Source: https://docs.tagshelf.dev/event-api/fileevents/file-status-update

Provides a concrete example of a JSON event payload, illustrating typical values for each field as defined in the schema. This example demonstrates how UUIDs, timestamps, URLs, and other data types are populated.

```json
{
  "event_id": "abcd4567-efgh-8910-ijkl-1234mnop5678",
  "event_type": "file_event_type",
  "event_time": "1652235600.00",
  "event": {
    "event_name": "file_status_update_event",
    "event_type": "file_event_type",
    "company_id": "78901234-7890-7890-7890-7890123456ij",
    "company_name": "Global Innovations",
    "file_id": "65432109-8765-8765-8765-543210987654",
    "blob_name": "annual_report_2023.pdf",
    "blob_url": "https://storage.globalinnov.com/annual_report_2023.pdf",
    "tag_id": "98765432-1234-1234-1234-123456789012",
    "tag_name": "Reviewed",
    "manual_classification": true,
    "classification_score": "0.94",
    "classification_status": "complete",
    "file_status": "active",
    "creation_date": "2023-05-19T17:10:00Z",
    "update_date": "2023-05-19T18:25:00Z"
  }
}
```

--------------------------------

### Example JSON Event Payload

Source: https://docs.tagshelf.dev/event-api/fileevents/filedone

Provides a concrete example of an event payload conforming to the defined JSON structure. This snippet illustrates typical values for event_id, event_type, timestamps, and nested event details like company, blob, file, and tag information.

```json
{
  "event_id": "fghi3456-kl78-9012-mn34-opqr56789012",
  "event_type": "file_event_type",
  "event_time": "1651224567.00",
  "event": {
    "event_name": "file_done_event",
    "event_type": "file_event_type",
    "company_id": "567j6789-k89l-34e6-c789-527614179000",
    "company_name": "Innovatech Ltd",
    "blob_name": "example_document.pdf",
    "blob_url": "https://storage.example.com/documents/example_document.pdf",
    "file_id": "890k7890-l12m-45f6-d890-638214180000",
    "tag_id": "345l8901-m23n-56g7-e901-739414181000",
    "tag_name": "Approved",
    "file_status": "completed",
    "creation_date": "2023-05-01T09:30:00Z",
    "update_date": "2023-05-02T11:45:00Z"
  }
}
```

--------------------------------

### Example JSON Payload for File Event Creation

Source: https://docs.tagshelf.dev/event-api/fileevents/file-category-create

Provides a concrete example of an event JSON payload, demonstrating typical values for event ID, type, time, and nested event details for a file category creation event, including UUIDs, timestamps, and descriptive text.

```json
{
  "event_id": "abcd1234-ef56-7890-gh12-ijkl34567890",
  "event_type": "file_event_type",
  "event_time": "1651018865.75",
  "event": {
    "event_name": "file_category_create_event",
    "event_type": "file_event_type",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "company_name": "Example Company",
    "file_log_id": "123e4567-e89b-12d3-a456-426614174002",
    "description": "Initial classification",
    "confidence": "0.95",
    "creation_date": "2023-04-26T12:00:00Z",
    "update_date": "2023-04-27T12:00:00Z"
  }
}
```

--------------------------------

### Example JSON Payload for File Event

Source: https://docs.tagshelf.dev/event-api/fileevents/file-extracted-data-create

An example of a file event JSON payload, demonstrating the structure with sample data. This snippet provides concrete values for all defined fields, including UUIDs, timestamps, and textual content, illustrating a typical file extraction event.

```json
{
  "event_id": "mnop4567-qr89-0123-st45-uvwxy6789012",
  "event_type": "file_event_type",
  "event_time": "1651325678.10",
  "event": {
    "event_name": "file_extracted_data_create_event",
    "event_type": "file_event_type",
    "company_id": "678m7891-n23o-67h8-f012-548614182000",
    "company_name": "TechAdventures",
    "file_log_id": "456n9012-o34p-78i9-j123-659314183000",
    "content": "Extracted text content or data from the document...",
    "provider": "DataExtractionService",
    "creation_date": "2023-05-03T10:15:00Z",
    "update_date": "2023-05-04T12:20:00Z"
  }
}
```

--------------------------------

### Example JSON Payload for a Job Event

Source: https://docs.tagshelf.dev/event-api/jobevents/job-create

Provides a concrete example of the JSON payload structure, illustrating typical values for event and job attributes such as UUIDs, timestamps, boolean flags, file counts, and URLs. This example demonstrates a 'job_create_event' for 'Acme Corp' initiated by 'john_doe'.

```JSON
{
  "event_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
  "event_type": "job_event_type",
  "event_time": "1652937600.00",
  "event": {
    "event_name": "job_create_event",
    "event_type": "job_event_type",
    "job_id": "12345678-1234-1234-1234-123456789abc",
    "user_name": "john_doe",
    "merge": "true",
    "metadata": "Batch processing of May invoices",
    "file_count": "150",
    "company_id": "87654321-4321-4321-4321-432143214321",
    "company_name": "Acme Corp",
    "file_urls": [
      "https://example.com/files/invoice1.pdf",
      "https://example.com/files/invoice2.pdf"
      // More URLs can be added as needed
    ],
    "creation_date": "2023-05-19T12:00:00Z",
    "update_date": "2023-05-19T12:30:00Z"
  }
}
```

--------------------------------

### Example JSON Payload for File Tag Removal Event

Source: https://docs.tagshelf.dev/event-api/fileevents/remove-tag

Provides a concrete example of a JSON payload for a 'file_change_tag_event', illustrating how the defined structure is populated with sample data. This helps in understanding the actual data format and values.

```JSON
{
  "event_id": "qrst2345-uvwx-4567-yzab-2345cdef6789",
  "event_type": "file_event_type",
  "event_time": "1652134500.00",
  "event": {
    "event_name": "file_change_tag_event",
    "event_type": "file_event_type",
    "company_id": "67890123-6789-6789-6789-6789012345gh",
    "company_name": "Dynamic Enterprises",
    "file_id": "32109876-9876-9876-9876-765432109876",
    "tag_being_removed_id": "43210987-0987-0987-0987-987654321098",
    "tag_being_removed_name": "Outdated",
    "classification_score": "0.86"
  }
}
```

--------------------------------

### Example JSON Payload for File Move to Recycle Bin Event

Source: https://docs.tagshelf.dev/event-api/fileevents/move-to-recycle-bin

This example demonstrates a complete JSON payload for a 'file_move_to_recycle_bin_event', illustrating the data structure with sample values for event details, company information, and file attributes including its new location in the recycle bin.

```JSON
{
  "event_id": "efgh8765-nopq-5432-cdef-5432abcd6789",
  "event_type": "file_event_type",
  "event_time": "1651831200.00",
  "event": {
    "event_name": "file_move_to_recycle_bin_event",
    "event_type": "file_event_type",
    "company_id": "34567890-3456-3456-3456-3456789012cd",
    "company_name": "Creative Solutions",
    "file_id": "09876543-6543-6543-6543-432109876543",
    "file_name": "proposal_draft.docx",
    "file_name_without_extension": "proposal_draft",
    "blob_name": "recycle_bin/proposal_draft.docx",
    "blob_url": "https://storage.creativesol.com/recycle_bin/proposal_draft.docx",
    "creation_date": "2023-05-15T12:20:00Z",
    "update_date": "2023-05-15T13:35:00Z"
  }
}
```

--------------------------------

### Example JSON Payload for File Event

Source: https://docs.tagshelf.dev/event-api/fileevents/move

This example demonstrates a complete JSON payload for a file event, illustrating typical values for each field defined in the event schema. It includes specific UUIDs, a Unix timestamp, and file path details for a 'file_move_event'.

```JSON
{
  "event_id": "abcd2345-efgh-6789-ijkl-1234mnop5678",
  "event_type": "file_event_type",
  "event_time": "1651629000.00",
  "event": {
    "event_name": "file_move_event",
    "event_type": "file_event_type",
    "company_id": "12345678-1234-1234-1234-1234567890ab",
    "company_name": "Global Corp",
    "file_id": "87654321-4321-4321-4321-210987654321",
    "file_name": "report_2023.docx",
    "file_name_without_extension": "report_2023",
    "blob_name": "2023/reports/report_2023.docx",
    "blob_url": "https://storage.globalcorp.com/2023/reports/report_2023.docx",
    "previous_file_directory": "/previous_directory/2023/reports/",
    "new_file_directory": "/new_directory/2023/reports/",
    "creation_date": "2023-05-10T08:00:00Z",
    "update_date": "2023-05-10T09:00:00Z"
  }
}
```

--------------------------------

### Example: Successful OAuth Access Token Response

Source: https://docs.tagshelf.dev/authentication

This JSON example illustrates a successful response from the `/token` endpoint. It includes the `access_token` (bearer token), `token_type`, `expires_in` duration, `userName`, and the `issued` and `expires` timestamps for the token.

```JSON
{
  "access_token": "qW-TI5C1En4VH_EtZBZXFtPvUEJ-dzm-4X7Qb3eu58d5iXMHisdqGow2tHb5EvgmRKIgDBz1NMtzrFNOKzRzir3ZGB5nLXpfN0DfwiP5msoD5ns2YRKPKWVKjSDZQIPOtyWdYBteO5doH22b6wUFgy1HHn4pdpMihBocg1hwd5wQX7YmxEgOblT9sLuUAKqY3y-Qu6VOiJRSjQ4V3LDfrojVhzqMXDK3QvhZYSQ2nWoILB0A-NriuQbpmzXgxPP2q_R9wE_98rubEhUvW_0MwMFqaKwyIt1cPqskBy1UgdDvqJRcQUfq1v8yPE4WwBlW8mqLKPPSiCuAsG_1fB-0tqOfHU0BtDPPJ15ko1u6zJGMIZKZGn9XbCSU-a3iurbPmQK4NdmErT_wTjwpiH__ZNt0E9q6YhzyawEhBU1uL_F5rdmzZvTNZoB1xlUol2nASf0nQDeZqsD1ehBWeb2NrTGafST32Vfa6xVy_HpU4PH0vGLN5L-dEvbo5gl4z1KdDC7ZlKZGSfcderzh8_fAaFJ9vrL0jnffVb-sqLhsRh7_SdIn-43zl5EzbYjjyCDTwyPOnNppH7PGLoO8uLZPFDY1LBo_-T6IGzXPlFVwjgsa-YSTd37qKFlPPHMYa0Dm",
  "token_type": "bearer",
  "expires_in": 1209599,
  "userName": "admin@tagshelf.com",
  ".issued": "Fri, 10 Aug 2018 14:50:42 GMT",
  ".expires": "Fri, 24 Aug 2018 14:50:42 GMT"
}
```

--------------------------------

### Example JSON Payload for Job Event Update

Source: https://docs.tagshelf.dev/event-api/jobevents/job-stage-update

Provides a concrete example of a JSON payload for a job event, illustrating the data format and typical values for fields such as event IDs, timestamps, company details, and job stage updates. This example demonstrates a 'processing' stage update.

```json
{
  "event_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6",
  "event_type": "job_event_type",
  "event_time": "1653544200.00",
  "event": {
    "event_name": "job_stage_update_event",
    "event_type": "job_event_type",
    "company_id": "45678901-2345-2345-2345-234567890def",
    "company_name": "Dynamic Solutions",
    "job_id": "56789012-3456-3456-3456-345678901fgh",
    "stage": "processing",
    "creation_date": "2023-05-25T22:10:00Z",
    "update_date": "2023-05-25T23:40:00Z"
  }
}
```

--------------------------------

### Example JSON Payload for File Event

Source: https://docs.tagshelf.dev/event-api/fileevents/move-to-pending

This is an example of a JSON payload representing a file event, demonstrating the structure and typical values for fields like event ID, timestamps, company details, and file metadata. It shows a 'file_move_to_pending_event' with specific UUIDs, dates, and URLs.

```json
{
  "event_id": "dcba4321-mlkj-9876-ponm-8765lkji4321",
  "event_type": "file_event_type",
  "event_time": "1651730100.00",
  "event": {
    "event_name": "file_move_to_pending_event",
    "event_type": "file_event_type",
    "company_id": "23456789-2345-2345-2345-2345678901bc",
    "company_name": "Innovate Ltd",
    "file_id": "98765432-5432-5432-5432-321098765432",
    "file_name": "monthly_report.xlsx",
    "file_name_without_extension": "monthly_report",
    "blob_name": "pending/monthly_report.xlsx",
    "blob_url": "https://storage.innovateltd.com/pending/monthly_report.xlsx",
    "creation_date": "2023-05-12T10:15:00Z",
    "update_date": "2023-05-12T11:30:00Z"
  }
}
```

--------------------------------

### Example 200 OK Response for Deferred Session Details

Source: https://docs.tagshelf.dev/enpoints/deferred-session

An example JSON response body returned upon successful retrieval of a Deferred Session's details, showing its unique identifier, creation and update timestamps, current status, associated user, company, and job ID.

```JSON
{
    "id": "0f767925-b464-4ffa-b621-1a0aeacad257",
    "creation_date": "2022-11-17T00:00:00.000",
    "update_date": "2022-11-17T00:00:00.000",
    "status": "open",
    "user_name": "SuperTagShelf",
    "company_id": "286e2ed0-3626-4faa-a745-8ebf3488fbd7",
    "job_id": null
}
```

--------------------------------

### Example JSON Payload for File Property Creation Event

Source: https://docs.tagshelf.dev/event-api/fileevents/property-create

An example of a JSON payload representing a 'file_property_create_event'. This snippet demonstrates how the defined schema is populated with sample data, including UUIDs, timestamps, and specific values for file properties like 'Document Type' and 'Confidential Report'.

```JSON
{
  "event_id": "ijkl9876-rstv-6789-fghi-6789defg0123",
  "event_type": "file_event_type",
  "event_time": "1651932300.00",
  "event": {
    "event_name": "file_property_create_event",
    "event_type": "file_event_type",
    "company_id": "45678901-4567-4567-4567-4567890123de",
    "company_name": "NextGen Innovations",
    "file_log_id": "10987654-7654-7654-7654-543210987654",
    "name": "Document Type",
    "value": "Confidential Report",
    "creation_date": "2023-05-17T14:25:00Z",
    "update_date": "2023-05-17T15:40:00Z"
  }
}
```

--------------------------------

### Example JSON Payload for a File Update Event

Source: https://docs.tagshelf.dev/event-api/fileevents/update

This snippet provides a concrete example of the JSON payload structure, demonstrating typical values for a 'file_update_event'. It illustrates the UUID, timestamp, URL, and date formats as specified in the schema, showing how a real event might be represented with sample data.

```JSON
{
  "event_id": "mnop5678-qrst-9012-uvwx-3456yzab7890",
  "event_type": "file_event_type",
  "event_time": "1652336700.00",
  "event": {
    "event_name": "file_update_event",
    "event_type": "file_event_type",
    "company_id": "89012345-8901-8901-8901-8901234567kl",
    "company_name": "Tech Frontier",
    "file_id": "54321098-7654-7654-7654-432109876543",
    "file_log_id": "12345678-9012-3456-7890-123456789012",
    "file_name": "project_outline.docx",
    "file_name_without_extension": "project_outline",
    "blob_name": "docs/project_outline.docx",
    "blob_url": "https://storage.techfrontier.com/docs/project_outline.docx",
    "creation_date": "2023-05-20T19:15:00Z",
    "update_date": "2023-05-20T20:30:00Z"
  }
}
```

--------------------------------

### Example JSON Payload for a Job Retry Event

Source: https://docs.tagshelf.dev/event-api/jobevents/job-retry

Illustrates a concrete instance of the event JSON payload, showing typical values for a 'job_retry_event'. This example includes specific UUIDs, timestamps, boolean flags, and array data for error messages and file URLs.

```json
{
  "event_id": "z1x2c3v4-b5n6-m7q8-w9e0-r1t2y3u4i5o6",
  "event_type": "job_event_type",
  "event_time": "1653443100.00",
  "event": {
    "event_name": "job_retry_event",
    "event_type": "job_event_type",
    "job_id": "90123456-1234-1234-1234-1234567890kl",
    "user_name": "alex_case",
    "merge": "false",
    "metadata": "Reprocessing after system update",
    "file_count": "120",
    "retries": "2",
    "exceeded_retries": "false",
    "error_messages": [
      "System timeout on initial attempt",
      "Partial data corruption on second attempt"
    ],
    "company_id": "09876543-4321-4321-4321-432143214323",
    "company_name": "Innovation Works",
    "file_urls": [
      "https://example.com/files/data1.xlsx",
      "https://example.com/files/data2.xlsx"
    ],
    "creation_date": "2023-05-24T20:00:00Z",
    "
```

--------------------------------

### JobStartEvent API Usage and Triggers

Source: https://docs.tagshelf.dev/event-api/jobevents/job-start

Explains when the JobStartEvent is triggered, specifically at the commencement of a job's workflow, initiating its state machine. It provides examples of scenarios where this event would occur.

```APIDOC
JobStartEvent:
  Description: This event triggers when a job begins its workflow, initiating its state machine.
  Trigger Examples:
    - Commencement of a scheduled batch job for nightly processing.
    - Start of an ad-hoc job for immediate document processing.
```

--------------------------------

### Example JSON Payload for File Property Deletion Event

Source: https://docs.tagshelf.dev/event-api/fileevents/property-delete

This example demonstrates a concrete instance of the JSON payload structure, showing a 'file_property_delete_event' with sample UUIDs, timestamps, and property details like 'Security Level' and 'High Confidential'.

```JSON
{
  "event_id": "mnop0123-uvwx-0123-ijkl-9012ghij3456",
  "event_type": "file_event_type",
  "event_time": "1652033400.00",
  "event": {
    "event_name": "file_property_delete_event",
    "event_type": "file_event_type",
    "company_id": "56789012-5678-5678-5678-5678901234ef",
    "company_name": "Advanced Technologies",
    "file_log_id": "21098765-8765-8765-8765-654321098765",
    "name": "Security Level",
    "value": "High Confidential",
    "creation_date": "2023-05-18T16:30:00Z",
    "update_date": "2023-05-18T17:45:00Z"
  }
}
```

--------------------------------

### Example JSON Response for Document Search Results (200 OK)

Source: https://docs.tagshelf.dev/enpoints/search

An example of a successful JSON response (200 OK) from a document search API call. It includes a list of search results, each containing file metadata, tag information, and extracted data points, along with total count and emptiness status.

```JSON
{
    "result": [
        {
            "file_id": "d2bd5c6f-cd2a-490b-b93b-ee843ceba9ea",
            "job_id": "44f9423e-f36b-1410-8c10-0092b3381c4b",
            "channel": "web",
            "user_name": "admin@tagshelf.com",
            "length": 576.0,
            "tag_name": "Factura Fiscal",
            "tag_score": 0.95,
            "tag_source": "Alfred",
            "classifier": "zero",
            "creation_date": "2025-06-04T09:17:17.8Z",
            "update_date": "2025-06-04T09:23:16.703Z",
            "tag_id": "61b5433e-f36b-1410-8c0f-0092b3381c4b",
            "data_points": [
                {
                    "name": "InvoiceNumber",
                    "value": "RMP002-26",
                    "value_as_string": "RMP002-26",
                    "data_type": "String"
                },
                {
                    "name": "InvoiceDate",
                    "value": "2025-02-24T00:00:00",
                    "value_as_string": "2025-02-24T00:00:00.0000000",
                    "data_type": "DateTime"
                },
                {
                    "name": "InvoiceTotal",
                    "value": 260000.0,
                    "value_as_string": "260000.00",
                    "data_type": "Decimal"
                }
            ]
        },
        {
            "file_id": "d595fc17-e5b2-45c1-8fcd-0463b0aee014",
            "job_id": "36fb423e-f36b-1410-8c10-0092b3381c4b",
            "channel": "web",
            "user_name": "admin@tagshelf.com",
            "length": 576.0,
            "tag_name": "Factura Fiscal",
            "tag_score": 0.95,
            "tag_source": "Alfred",
            "classifier": "zero",
            "creation_date": "2025-06-04T09:36:37.753Z",
            "update_date": "2025-06-04T09:47:33.73Z",
            "tag_id": "61b5433e-f36b-1410-8c0f-0092b3381c4b",
            "data_points": [
                {
                    "name": "InvoiceNumber",
                    "value": "RMP002-26",
                    "value_as_string": "RMP002-26",
                    "data_type": "String"
                },
                {
                    "name": "InvoiceDate",
                    "value": "2025-02-24T00:00:00",
                    "value_as_string": "2025-02-24T00:00:00.0000000",
                    "data_type": "DateTime"
                },
                {
                    "name": "InvoiceTotal",
                    "value": 260000.0,
                    "value_as_string": "260000.00",
                    "data_type": "Decimal"
                }
            ]
        }
    ],
    "total": 2,
    "is_empty": false
}
```

--------------------------------

### Successful Job Creation Response (200 OK)

Source: https://docs.tagshelf.dev/enpoints/job

Example JSON response indicating a successful operation, returning the unique job ID.

```JSON
{
    "job_id": "ce533119-4266-4bfe-aa32-9466f751ca61"
}
```

--------------------------------

### Example JSON Payload for File Tag Change Event

Source: https://docs.tagshelf.dev/event-api/fileevents/file-change-tag

Provides a concrete example of an event payload, illustrating a 'file_change_tag_event'. This snippet showcases typical values for UUIDs, timestamps, company and file details, and the transition from a previous tag to a new, proposed tag with a classification score.

```json
{
  "event_id": "defg2345-hi67-8901-jk23-lmnop7890123",
  "event_type": "file_event_type",
  "event_time": "1651123456.90",
  "event": {
    "event_name": "file_change_tag_event",
    "event_type": "file_event_type",
    "company_id": "456f5678-g89h-23d4-b567-426614175000",
    "company_name": "Dynamic Solutions",
    "file_id": "789g6789-h12i-34d5-e678-529214176000",
    "previous_tag_id": "00000000-0000-0000-0000-000000000000",
    "previous_tag_name": "null",
    "proposed_tag_id": "891h7890-i23j-45d6-f789-630314177000",
    "classification_score": "0.88",
    "new_tag_id": "234i3456-j45k-56e7-g891-731414178000",
    "new_tag_name": "Urgent"
  }
}
```

--------------------------------

### Get Company Tags API Endpoint

Source: https://docs.tagshelf.dev/enpoints/account

Retrieves a list of tags associated with a specific company ID. This request is valid only for companies the requesting user has access to. It details the GET method, path parameters, required headers, and provides an example of a successful 200 OK response.

```APIDOC
GET https://tagshelf.host/api/account/tags/:company-id

Path Parameters:
  company-id*: UUID - Company ID

Headers:
  X-TagshelfAPI-Key: String - Application API Key
  Authorization: String - Bearer <access_token> or amx <hmac_token>
  User-Agent*: String - Identifier for application, operating system, vendor, and/or version of the requesting user agent

200 OK Response Body:
[
    {
        "id": "c13e4c7f-bdeb-4820-858b-2b921e62291c",
        "name": "FACTURA",
        "description": null
    }
]
```

--------------------------------

### Get Metadata Values Response (200 OK)

Source: https://docs.tagshelf.dev/enpoints/values

An example JSON array representing the successful response when retrieving metadata values for a given file ID. Each object in the array contains details about a specific metadata entry, including its ID, associated file log ID, metadata ID, name, value, and classification score.

```JSON
[
  {
    "id": "c40e0384-9d4b-4e12-83e6-29a181f31254",
    "file_log_id": "9ddb16be-2875-4891-9edc-ec457adc252c",
    "metadata_id": "813966a3-f340-42c7-a1eb-188718c46a8a",
    "metadata_name": "InvoiceNo",
    "value": "222436",
    "classification_score": 1.0
  },
  ...
]
```

--------------------------------

### Invalid Pagination Parameters API Error Response (400 BAD REQUEST)

Source: https://docs.tagshelf.dev/enpoints/job

Example JSON response for an API call that fails due to invalid pagination parameters. It provides an error message indicating the specific issue with `pageSize` or `currentPage`, guiding developers on how to correct their requests.

```JSON
{
  "error": "Invalid Pagination Parameters",
  "message": "The 'pageSize' parameter must be an integer between 10 and 40. The 'currentPage' parameter must be a positive integer."
}
```

--------------------------------

### Successful Tagshelf Jobs List API Response Example (200 OK)

Source: https://docs.tagshelf.dev/enpoints/job

Example JSON response for a successful API call to retrieve a paginated list of Tagshelf Jobs. It includes an array of job objects with detailed attributes and pagination metadata, demonstrating the structure of a typical successful response.

```JSON
{
  "jobs": [
    {
      "id": "78dd6181-00aa-4ded-aeaf-57803bbddae3",
      "creation_date": "2021-08-06T15:15:54.12",
      "has_job_request_info": false,
      "job_request_date": null,
      "update_date": "2022-11-17T21:12:27.813",
      "company_id": "286e2ed0-3626-4faa-a745-8ebf3488fbd7",
      "bulk_id": null,
      "deferred_session_id": null,
      "user_name": "SuperTagShelf",
      "channel": null,
      "source": null,
      "container": null,
      "remote_file_name": null,
      "remote_file_names": null,
      "merge": false,
      "decompose": true,
      "propagate_metadata": false,
      "parent_file_prefix": "Formularios Reclamacion",
      "decomposed_page_rotation": -1,
      "file_count": 19,
      "file_sources_count": 0,
      "metadata_objects_count": 0,
      "finished_files": 7,
      "files": [
        {
          "id": "8758c19f-815e-401f-ac6d-170a665d757d",
          "creation_date": "2021-08-06T15:17:21.793",
          "update_date": "2021-08-06T15:18:51.26",
          "file_name": "85a3ae7008b94322b8972e405803233d.png",
          "tag_name": "",
          "is_parent": false,
          "is_children": true,
          "status": "finished"
        }
      ],
      "retries": 0,
      "exceeded_retries": false,
      "file_urls": ["https://bucket.tagshelf.com/static/test.pdf"],
      "error_messages": [],
      "stage": "in_progress",
      "start_date": "2021-08-06T15:16:00.257",
      "email_from": null,
      "email_subject": null,
      "email_body": null
    }
  ],
  "pagination": {
      "currentPage": 1,
      "totalPages": 5,
      "pageSize": 20,
      "totalJobs": 100
  }
}
```

--------------------------------

### Example 404 NOT FOUND Response for Deferred Session

Source: https://docs.tagshelf.dev/enpoints/deferred-session

An example JSON response body returned when the requested Deferred Session ID does not correspond to an existing session, indicating a 'Not Found' error.

```JSON
{
  "error": "Not Found",
  "message": "Deferred Session with ID 456f1234-e89b-12d3-a456-426655440000 does not exist."
}
```

--------------------------------

### Bad Request Error Response (400 BAD REQUEST)

Source: https://docs.tagshelf.dev/enpoints/job

Example JSON response for an invalid request, detailing the error type and a descriptive message.

```JSON
{
  "error": "Bad Request",
  "message": "Invalid input parameters. Please check your data."
}
```

--------------------------------

### Example JSON Payload for Failed Job Event

Source: https://docs.tagshelf.dev/event-api/jobevents/job-failed

Provides a concrete example of the JSON payload for a job failure event. It illustrates the data format and typical values for fields like event ID, type, time, company, job details, and error messages, demonstrating how the defined structure is populated.

```JSON
{
  "event_id": "f3g4h5i6-j7k8-l9m0-n1o2-p3q4r5s6t7u8",
  "event_type": "job_event_type",
  "event_time": "1653139800.00",
  "event": {
    "event_name": "job_failed_event",
    "event_type": "job_event_type",
    "company_id": "34567890-4567-4567-4567-4567890123ef",
    "company_name": "Innovative Solutions",
    "job_id": "45678901-5678-5678-5678-5678901234fg",
    "retries": "3",
    "exceeded_retries": "false",
    "error_messages": [
      "Network connectivity issues",
      "Database timeout error"
    ],
    "creation_date": "2023-05-21T15:20:00Z",
    "update_date": "2023-05-21T16:40:00Z"
  }
}
```

--------------------------------

### Example Tagshelf Job Object Response

Source: https://docs.tagshelf.dev/enpoints/job

A sample JSON object representing the structure of a Tagshelf Job, typically returned upon successful job creation or when querying job status. It includes details such as job ID, creation/update dates, company ID, file counts, and individual file statuses.

```json
{
  "id": "78dd6181-00aa-4ded-aeaf-57803bbddae3",
  "creation_date": "2021-08-06T15:15:54.12",
  "has_job_request_info": false,
  "job_request_date": null,
  "update_date": "2022-11-17T21:12:27.813",
  "company_id": "286e2ed0-3626-4faa-a745-8ebf3488fbd7",
  "bulk_id": null,
  "deferred_session_id": null,
  "user_name": "SuperTagShelf",
  "channel": null,
  "source": null,
  "container": null,
  "remote_file_name": null,
  "remote_file_names": null,
  "merge": false,
  "decompose": true,
  "propagate_metadata": false,
  "parent_file_prefix": "Formularios Reclamacion",
  "decomposed_page_rotation": -1,
  "file_count": 19,
  "file_sources_count": 0,
  "metadata_objects_count": 0,
  "finished_files": 7,
  "files": [
    {
      "id": "8758c19f-815e-401f-ac6d-170a665d757d",
      "creation_date": "2021-08-06T15:17:21.793",
      "update_date": "2021-08-06T15:18:51.26",
      "file_name": "85a3ae7008b94322b8972e405803233d.png",
      "tag_name": "",
      "is_parent": false,
      "is_children": true,
      "status": "finished"
    },
    ...
  ],
  "retries": 0,
  "exceeded_retries": false,
  "file_urls": ["https://bucket.tagshelf.com/static/test.pdf"],
  "error_messages": [],
  "stage": "in_progress",
  "start_date": "2021-08-06T15:16:00.257",
  "email_from": null,
  "email_subject": null,
  "email_body": null
}
```

--------------------------------

### Example JobFinishedEvent JSON Payload

Source: https://docs.tagshelf.dev/event-api/jobevents/job-finished

This snippet provides a concrete example of the JobFinishedEvent JSON payload, populated with sample data. It illustrates how the defined structure translates into actual event data, including UUIDs, timestamps, and dates.

```JSON
{
  "event_id": "u7v8w9x0-y1z2-a3b4-c5d6-e7f8g9h0i1j2",
  "event_type": "job_event_type",
  "event_time": "1653240900.00",
  "event": {
    "event_name": "job_finished_event",
    "event_type": "job_event_type",
    "company_id": "56789012-6789-6789-6789-6789012345gh",
    "company_name": "Tech Pioneers",
    "job_id": "67890123-7890-7890-7890-7890123456hi",
    "creation_date": "2023-05-22T16:30:00Z",
    "update_date": "2023-05-22T17:50:00Z"
  }
}

```

--------------------------------

### Example JSON Payload for File Event

Source: https://docs.tagshelf.dev/event-api/fileevents/file-extracted-data-delete

This JSON object provides a concrete example of an event payload, demonstrating the structure and typical values for a file extracted data deletion event. It includes sample UUIDs, a Unix timestamp, and specific details for a file event such as company information, file log ID, content, provider, and ISO 8601 formatted dates.

```JSON
{
  "event_id": "qrst5678-uv90-1234-wx56-yzab78901234",
  "event_type": "file_event_type",
  "event_time": "1651426789.20",
  "event": {
    "event_name": "file_extracted_data_delete_event",
    "event_type": "file_event_type",
    "company_id": "789o0123-p45q-89r1-s234-567814184000",
    "company_name": "DataSolutions Inc",
    "file_log_id": "567p1234-q56r-90s2-t345-678914185000",
    "content": "Previously extracted text content that is now being deleted...",
    "provider": "DataExtractionService",
    "creation_date": "2023-05-05T13:25:00Z",
    "update_date": "2023-05-06T14:30:00Z"
  }
}
```

--------------------------------

### Example JSON Event Payload for File Failure

Source: https://docs.tagshelf.dev/event-api/fileevents/failed

This example demonstrates a complete JSON event payload for a 'file_failed_event'. It includes sample UUIDs, timestamps, URLs, and specific error messages, illustrating how a file processing failure would be reported.

```JSON
{
  "event_id": "uvwx6789-xy01-2345-z678-abcd90123456",
  "event_type": "file_event_type",
  "event_time": "1651527890.30",
  "event": {
    "event_name": "file_failed_event",
    "event_type": "file_event_type",
    "company_id": "890q1234-r56s-78t9-u012-679014186000",
    "company_name": "CloudTech Innovations",
    "blob_name": "report_final_draft.docx",
    "blob_url": "https://storage.cloudtech.com/documents/report_final_draft.docx",
    "file_id": "678q2345-r67s-89t0-v123-780114187000",
    "tag_id": "789r3456-s78t-01u2-w234-891214188000",
    "tag_name": "Review Needed",
    "classification_score": "0.82",
    "classification_status": "pending_review",
    "file_status": "failed",
    "error_messages": [
      "Document corrupt and cannot be opened",
      "Failed to connect to document parser service"
    ],
    "creation_date": "2023-05-07T16:40:00Z",
    "update_date": "2023-05-08T17:50:00Z"
  }
}
```

--------------------------------

### Example: 200 OK Response for Tag Classification

Source: https://docs.tagshelf.dev/enpoints/tag

A sample JSON array representing a successful 200 OK response, typically containing classified file details such as file ID, RNC, amount, and date.

```JSON
[
    {
        "file_id": "5fcee04a-7102-40a2-9d4a-aee3c3c39bb",
        "rnc": "1923829",
        "monto": "390.00",
        "fecha": "2022-02-03"
    },
    ...
]
```

--------------------------------

### System Status Response (200 OK)

Source: https://docs.tagshelf.dev/enpoints/values

An example JSON response indicating the current operational status and version of the Tagshelf system. This response is typically returned upon a successful status check.

```JSON
{
  "currentVersion": "1.11.1.0",
  "status": "Online"
}
```
Tokens:
Raw