Skip to main content

API Reference

Scores API is a RESTful API that uses JSON for request and response bodies. It follows standard HTTP methods and status codes, providing a robust interface for managing score-related data in the Overture platform.

Access​

Depending on your environment, the Scores Swagger API can be accessed from the following URLs:

  • Development URL: http://localhost:8087/swagger-ui.html
  • Example production URL: https://score.demo.overture.bio/swagger-ui.html

Authentication​

In production environments, all requests to the Score API require authentication using an API key.

Include your API key in the Authorization header of each request as follows:

Authorization: Bearer YOUR_API_KEY
API Key Access & Management

For information on setting up the API key provider on a deployed Overture platform, see our Keycloak deployment guide.

For information on generating and managing API keys in Overture using Keycloak, see our Keycloak configuration reference.

Endpoints​

The following Swagger UI provides an interactive reference for all available Score API endpoints. You can explore the endpoints, request parameters and response schemas from the interface below.

Need Help?​

If you encounter any issues or have questions about our API, please don't hesitate to reach out through our support page or our discussion forum.