Skip to main content
GET
/
v1
/
app
/
project
/
{projectId}
/
artifact
{
  "data": [
    {
      "id": "<string>",
      "parent_id": "<string>",
      "child_count": 123,
      "project_id": "<string>",
      "project": {
        "id": "<string>",
        "name": "<string>",
        "goal": "<string>",
        "default_member_role": "Viewer",
        "default_role_enabled": true,
        "deadline": "<string>",
        "visibility": "Public",
        "member_count": 123,
        "members": [
          {
            "id": "<string>",
            "role": "Viewer",
            "user": {
              "id": "<string>",
              "org_id": "<string>",
              "account_id": "<string>",
              "profile_picture": "<string>",
              "name": "<string>",
              "email": "<string>",
              "job_position_name": "<string>",
              "job_position_description": "<string>",
              "state": "Active",
              "roles": [
                "AppGuest"
              ],
              "created_at": "<string>"
            },
            "is_project_member": true
          }
        ],
        "project_context": "<string>",
        "answer_context": "<string>",
        "is_pinned": true
      },
      "name": "<string>",
      "description": "<string>",
      "type": "InlineText",
      "source": "User",
      "state": "Initializing",
      "error": "Unknown",
      "ingest_status": "NotApplicable",
      "ingest_warnings": [
        "Unknown"
      ],
      "ingest_progress": 123,
      "has_content": true,
      "content": "<string>",
      "raw_content": "<string>",
      "integration_id": "<string>",
      "external_url": "<string>",
      "config": {
        "entity": {
          "id": "<string>",
          "name": "<string>",
          "goal": "<string>",
          "default_member_role": "Viewer",
          "default_role_enabled": true,
          "deadline": "<string>",
          "visibility": "Public",
          "member_count": 123,
          "members": [
            {
              "id": "<string>",
              "role": "Viewer",
              "user": {
                "id": "<string>",
                "org_id": "<string>",
                "account_id": "<string>",
                "profile_picture": "<string>",
                "name": "<string>",
                "email": "<string>",
                "job_position_name": "<string>",
                "job_position_description": "<string>",
                "state": "Active",
                "roles": [
                  "AppGuest"
                ],
                "created_at": "<string>"
              },
              "is_project_member": true
            }
          ],
          "project_context": "<string>",
          "answer_context": "<string>",
          "is_pinned": true
        }
      },
      "file_uri": "<string>",
      "artifact_references": [
        {}
      ],
      "keep_file_after_ingestion": true,
      "created_by": {
        "id": "<string>",
        "org_id": "<string>",
        "account_id": "<string>",
        "profile_picture": "<string>",
        "name": "<string>",
        "email": "<string>",
        "job_position_name": "<string>",
        "job_position_description": "<string>",
        "state": "Active",
        "roles": [
          "AppGuest"
        ],
        "created_at": "<string>"
      },
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "next_cursor": "<string>",
  "previous_cursor": "<string>",
  "has_next_page": true,
  "has_previous_page": true,
  "total_count": 123
}

Path Parameters

​
projectId
string
required

The ID of the project.

Query Parameters

​
state
enum<string>

A comma-separated list of artifact states to filter by. Example: 'Published,Processing'. If not provided, defaults to [Published, Processing].

Available options:
Initializing,
Processing,
Draft,
Deleted,
Published,
Unavailable,
Error
​
ingest_status
enum<string>

A comma-separated list of artifact ingest statuses to filter by. Example: 'Ingested,Failed'. If not provided, defaults to all statuses.

Available options:
NotApplicable,
NotStarted,
Processing,
Parsing,
Storing,
Done,
Error
​
type
enum<string>

A comma-separated list of artifact types to filter by. Example: 'Document,Image'.

Available options:
InlineText,
Document,
Folder,
Summary,
Composition,
SmartDoc,
Link,
BulkQA,
ReadAndExtract
​
order_by
enum<string>

The field by which to order the results. Example: 'createdAt', 'name'.

Available options:
Alphabetical
​
order
enum<string>

The sort order for the results: ASC for ascending, DESC for descending. Defaults to ASC.

Available options:
ASC,
DESC,
ASC_NULLS_FIRST,
DESC_NULLS_FIRST,
ASC_NULLS_LAST,
DESC_NULLS_LAST
​
created_by
string

Filter results by the user ID who created the artifact.

​
filter_by_text
string

Text to filter artifacts by. Performs a text search over artifacts.

​
parent_id
string

Filter results by parent artifact ID.

​
filter_by_parent
boolean

If true, only artifacts with a parent ID will be included. Defaults to false.

​
sub_type
enum<string>

A comma-separated list of artifact sub-types to filter by. Example: 'Image,Report'.

Available options:
InlineText,
Document,
Folder,
Summary,
Composition,
SmartDoc,
Link,
BulkQA,
ReadAndExtract
​
page
number

The absolute page number to fetch (1-based).

​
page_size
number

Number of items per page. Default is 20.

​
page_order
string

Sort order for pagination. Options: ASC, DESC. Default is ASC.

​
after
string

The cursor or value to paginate after (for relative pagination).

​
before
string

The cursor or value to paginate before (for relative pagination).

​
first
number

Limits the result to the first N items (after cursor).

​
last
number

Limits the result to the last N items (before cursor).

​
total_count
boolean

Include the total count in the response.

Response

200 - application/json

Returns a paginated list of artifacts for the specified project

​
data
object[]
required
​
has_next_page
boolean
required
​
has_previous_page
boolean
required
​
next_cursor
string
​
previous_cursor
string
​
total_count
number