Add file to graph

Add a file to a Knowledge Graph. Team access is inherited from the Knowledge Graph; the file itself does not carry team parameters.

POST /v1/graphs/{graph_id}/file

cURL

cURL

curl --location --request POST https://api.writer.com/v1/graphs/{graph_id}/file \
 --header "Authorization: Bearer <token>" \
 --header "Content-Type: application/json" \
--data-raw '{"file_id":"string"}'

200

{
  "id": "7c36a365-392f-43ba-840d-8f3103b42572",
  "created_at": "2024-07-10T15:16:10.684826Z",
  "name": "example.pdf",
  "graph_id": [
    "50daa3d0-e7d9-44a4-be42-b53e2379ebf7"
  ]
}

Knowledge Graphs can be deployed org-wide (accessible to every team in the organization) or deployed to specific teams. Both are accessible via the API and SDK.

• With an org-scoped API key, control team scope from the request body: pass team_ids on create or update, or filter list with the team_ids query parameter. Omit team_ids on list to see only org-wide Knowledge Graphs.
• With a team-scoped API key, every request is automatically restricted to the key’s team. Create assigns to that team; list and retrieve return only that team’s Knowledge Graphs; body team_ids is not accepted.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your Writer API key.

Path Parameters

graph_id · string<uuid> · required

The unique identifier of the Knowledge Graph.

Body

application/json

file_id · string · required

The unique identifier of the file.

Response

200 - application/json

id · string · required

A unique identifier of the file.

created_at · string<date-time> · required

The timestamp when the file was uploaded.

name · string · required

The name of the file.

graph_ids · string<uuid>[] · required

A list of Knowledge Graph IDs that the file is associated with.

If you provided a graphId during upload, the file is associated with that Knowledge Graph. However, the graph_ids field in the upload response is an empty list. The association will be visible in the graph_ids list when you retrieve the file using the file retrieval endpoint.

status · string · required

The processing status of the file.