Orpheus Getting Started

Getting Started

The Orpheus Knowledge Graph API is a powerful GraphQL API designed for searching, querying, and exploring the Orpheus Biomedical Knowledge Graph. This graph contains millions of biomedical entities and billions of facts, aggregated from multiple data sources.

This guide provides a basic overview of interacting with the Orpheus Knowledge Graph API. For more detailed information, refer to our official Postman collection link.

Prerequisites

• API Key: To access the API, you need an API key. Request one here.

• GraphQL: This guide assumes you are familiar with GraphQL for API testing.

Authentication

To authenticate with the Wisecube Graph API, include your API key in the header of each request:

{
  "key": "x-api-key",
  "value": "YOUR_API_KEY"
}

Replace YOUR_API_KEY with your actual API key.

API Endpoints

Advanced Graph Query

• Endpoint: POST https://{{wisecube-api}}/orpheus-dev/graphql

• Description: Allows querying the knowledge graph using SPARQL.

• Request Body:

  • GraphQL Query: A SPARQL query string.

  • Variables: JSON object containing variables for the GraphQL query.

Natural Language Query

• Endpoint: POST https://{{wisecube-api}}/orpheus/graphql

• Description: Query the knowledge graph using natural language.

• Request Body:

  • GraphQL Query: A query string in natural language.

  • Variables: JSON object containing variables for the GraphQL query.

Search Entities

• Endpoint: POST https://{{wisecube-api}}/orpheus/graphql

• Description: Search for entities in the knowledge graph that match a query term.

• Request Body:

  • GraphQL Query: A query string for searching entities.

  • Variables: JSON object containing variables for the GraphQL query.

Search Articles

• Endpoint: POST https://{{wisecube-api}}/orpheus/graphql

• Description: Search for articles in the knowledge graph that match a query term.

• Request Body:

  • GraphQL Query: A query string for searching articles.

  • Variables: JSON object containing variables for the GraphQL query.

Generic Insights & QA

• Endpoint: POST https://staging-api.wisecube.ai/graphql

• Description: Retrieve general insights and answers to questions based on the knowledge graph.

• Request Body:

  • GraphQL Query: A query string for retrieving insights or answers.

  • Variables: JSON object containing variables for the GraphQL query.

Error Handling

Responses from the API will include HTTP status codes to indicate the success or failure of the request. Common codes include:

• 200 OK: The request was successful.

• 400 Bad Request: The request was invalid or cannot be served.

• 401 Unauthorized: Authentication failed or user does not have permissions for the requested operation.

• 500 Internal Server Error: An error occurred in the server.

Best Practices

• Rate Limiting: Be mindful of the rate limits to avoid service disruptions.

• Error Handling: Implement robust error handling in your application to manage API errors gracefully.

• Security: Keep your API key secure. Do not expose it in client-side code.

Support

For additional support or questions, contact Wisecube Support.