Skip to main content
PUT
/
v1
/
app
/
project
/
{projectId}
/
artifact
/
{artifactId}
Update artifact
curl --request PUT \
  --url https://{base_url}/v1/app/project/{projectId}/artifact/{artifactId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "content": "<string>"
}
'
{
  "id": "<string>",
  "project_id": "<string>",
  "name": "<string>",
  "type": "InlineText",
  "source": "User",
  "state": "Initializing",
  "ingest_status": "NotApplicable",
  "has_content": true,
  "props": {
    "entity": {
      "id": "<string>",
      "name": "<string>",
      "default_member_role": "Viewer",
      "default_role_enabled": true,
      "visibility": "Public",
      "goal": "<string>",
      "deadline": "<string>",
      "member_count": 123,
      "members": [
        {
          "id": "<string>",
          "role": "Viewer",
          "user": {
            "id": "<string>",
            "org_id": "<string>",
            "account_id": "<string>",
            "name": "<string>",
            "email": "<string>",
            "state": "Active",
            "roles": [
              "AppGuest"
            ],
            "created_at": "<string>",
            "profile_picture": "<string>",
            "job_position_name": "<string>",
            "job_position_description": "<string>"
          },
          "is_project_member": true
        }
      ],
      "project_context": "<string>",
      "answer_context": "<string>",
      "is_pinned": true
    }
  },
  "keep_file_after_ingestion": true,
  "created_at": "<string>",
  "updated_at": "<string>",
  "ws_auto_select": true,
  "parent_id": "<string>",
  "child_count": 123,
  "project": {
    "id": "<string>",
    "name": "<string>",
    "default_member_role": "Viewer",
    "default_role_enabled": true,
    "visibility": "Public",
    "goal": "<string>",
    "deadline": "<string>",
    "member_count": 123,
    "members": [
      {
        "id": "<string>",
        "role": "Viewer",
        "user": {
          "id": "<string>",
          "org_id": "<string>",
          "account_id": "<string>",
          "name": "<string>",
          "email": "<string>",
          "state": "Active",
          "roles": [
            "AppGuest"
          ],
          "created_at": "<string>",
          "profile_picture": "<string>",
          "job_position_name": "<string>",
          "job_position_description": "<string>"
        },
        "is_project_member": true
      }
    ],
    "project_context": "<string>",
    "answer_context": "<string>",
    "is_pinned": true
  },
  "description": "<string>",
  "error": "Unknown",
  "ingest_warnings": [
    "Unknown"
  ],
  "ingest_progress": 123,
  "content": "<string>",
  "raw_content": "<string>",
  "integration_id": "<string>",
  "external_url": "<string>",
  "file_uri": "<string>",
  "artifact_references": "<array>",
  "created_by": {
    "id": "<string>",
    "org_id": "<string>",
    "account_id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "state": "Active",
    "roles": [
      "AppGuest"
    ],
    "created_at": "<string>",
    "profile_picture": "<string>",
    "job_position_name": "<string>",
    "job_position_description": "<string>"
  }
}

Path Parameters

​
projectId
string
required

The ID of the project

​
artifactId
boolean
required

The ID of the artifact data to be updated

Body

application/json

The fields of the artifact to be updated

​
name
string
​
parent_id
string
​
reset_parent_id
boolean
​
external_url
string
​
props
object
​
private_props
object
​
description
string
​
content
string
​
plain_text_content
string
​
ws_auto_select
boolean

Response

200 - application/json

Returns the updated artifact details

​
id
string
required
​
project_id
string
required
​
name
string
required
​
type
enum<string>
required
Available options:
InlineText,
Document,
Folder,
Summary,
Composition,
SmartDoc,
Link,
BulkQA,
ReadAndExtract,
SqlDatabase,
McpServer
​
source
enum<string>
required
Available options:
User,
SharePoint,
Confluence,
Claromentis,
FileSystem,
Mock
​
state
enum<string>
required
Available options:
Initializing,
Processing,
Draft,
Deleted,
Published,
Unavailable,
Error
​
ingest_status
enum<string>
required
Available options:
NotApplicable,
NotStarted,
Processing,
Parsing,
Storing,
Done,
Error
​
has_content
boolean
required
​
props
object
required
​
keep_file_after_ingestion
boolean
required
​
created_at
string
required
​
updated_at
string
required
​
ws_auto_select
boolean
required
​
parent_id
string
​
child_count
number
​
project
object
​
description
string
​
error
enum<string>
Available options:
Unknown,
InternalError,
MismatchedType,
InvalidExtension,
ParsingFailure,
MaxNodes,
Malformed,
Encrypted,
NoValidFile,
NoValidNodes
​
ingest_warnings
enum<string>[]
Available options:
Unknown,
BigSize,
FallbackToPdfToText,
UsingVLMForExtraction,
ExceedsRecommendedPages,
SpecialConfig,
NoContent,
UnprocessableContent,
DescendantHasError
​
ingest_progress
number
​
content
string
​
raw_content
string
​
integration_id
string
​
external_url
string
​
file_uri
string
​
artifact_references
array
​
created_by
object