Question - Writer AI Studio

cURL

curl --location --request POST https://api.writer.com/v1/graphs/question \
 --header "Authorization: Bearer <token>" \
 --header "Content-Type: application/json" \
--data-raw '{"graph_ids":["182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"],"question":"What is the generic name for the drug Bavencio?"}'

import os
from writerai import Writer

client = Writer(
    # This is the default and can be omitted
    api_key=os.environ.get("WRITER_API_KEY"),
)
question = client.graphs.question(
    graph_ids=["182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"],
    question="What is the generic name for the drug Bavencio?"
)
print(question.answer)

import Writer from 'writer-sdk';

const client = new Writer({
  apiKey: process.env['WRITER_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const question = await client.graphs.question({
    graph_ids: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'],
    question: 'What is the generic name for the drug Bavencio?'
});

  console.log(question.answer);
}

main();

{
  "question": "What is the generic name for the drug Bavencio?",
  "answer": "avelumab",
  "sources": [
    {
      "file_id": "1234",
      "snippet": "Bavencio is the brand name for avelumab."
    }
  ]
}

POST

/

v1

/

graphs

/

question

cURL

curl --location --request POST https://api.writer.com/v1/graphs/question \
 --header "Authorization: Bearer <token>" \
 --header "Content-Type: application/json" \
--data-raw '{"graph_ids":["182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"],"question":"What is the generic name for the drug Bavencio?"}'

import os
from writerai import Writer

client = Writer(
    # This is the default and can be omitted
    api_key=os.environ.get("WRITER_API_KEY"),
)
question = client.graphs.question(
    graph_ids=["182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"],
    question="What is the generic name for the drug Bavencio?"
)
print(question.answer)

import Writer from 'writer-sdk';

const client = new Writer({
  apiKey: process.env['WRITER_API_KEY'], // This is the default and can be omitted
});

async function main() {
  const question = await client.graphs.question({
    graph_ids: ['182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'],
    question: 'What is the generic name for the drug Bavencio?'
});

  console.log(question.answer);
}

main();

{
  "question": "What is the generic name for the drug Bavencio?",
  "answer": "avelumab",
  "sources": [
    {
      "file_id": "1234",
      "snippet": "Bavencio is the brand name for avelumab."
    }
  ]
}

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.

Body

application/json

graph_ids

string<uuid>[]

required

The unique identifiers of the Knowledge Graphs to query.

Minimum array length: 1

question

string

required

The question to answer using the Knowledge Graph.

subqueries

boolean

default:false

Specify whether to include subqueries.

stream

boolean

default:false

Determines whether the model's output should be streamed. If true, the output is generated and sent incrementally, which can be useful for real-time applications.

query_config

graph_query_config · object

Configuration options for Knowledge Graph queries, including search parameters and citation settings.

Show child attributes

Response

question

string

required

The question that was asked.

answer

string

required

The answer to the question.

sources

(source · object | null)[]

required

A source snippet containing text and fileId from Knowledge Graph content.

Show child attributes

subqueries

(sub_query · object | null)[]

A sub-question generated to break down complex queries into more manageable parts, along with its answer and supporting sources.

Show child attributes

references

references · object

Detailed source information organized by reference type, providing comprehensive metadata about the sources used to generate the response.

Show child attributes