> For the complete documentation index, see [llms.txt](https://docs.scoredetect.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scoredetect.com/api/scoredetect-api.md).

# ScoreDetect API

ScoreDetect offers powerful integrations with the ScoreDetect API.

Welcome to the ScoreDetect API documentation! Here, you'll find all the information you need to set up and configure the ScoreDetect API for your specific needs.&#x20;

#### ScoreDetect API, via Postman

If you are comfortable with **Postman**, we have also created a link below:

[![Run In Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/45236274-48619fe0-14f9-431c-97c2-aa0895f189ed?action=collection%2Ffork\&source=rip_markdown\&collection-url=entityId%3D45236274-48619fe0-14f9-431c-97c2-aa0895f189ed%26entityType%3Dcollection%26workspaceId%3D11866154-17f4-4c5d-8819-d66912a2b194)

And here is a Video walkthrough of the ScoreDetect API, via Postman:

{% embed url="<https://youtu.be/QjxJBqADYI4>" %}
Video walkthrough of the ScoreDetect API
{% endembed %}

## Getting Started&#x20;

To start using the ScoreDetect API, you'll first need to sign up and obtain an API key. The API key is used to authenticate your requests and ensure secure communication between your application and our server. Once you have your API key, you can start making requests to the ScoreDetect API.

## Support

We are here to assist you with any questions or concerns you may have while using the ScoreDetect API. If you encounter any issues, need clarification, or require further guidance, please don't hesitate to reach out to our support team at <support@scoredetect.com>

We are dedicated to ensuring your integration with the ScoreDetect API is smooth and successful.

Thank you for choosing the ScoreDetect API. We hope it enhances your applications or systems and provides the best value to you!


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.scoredetect.com/api/scoredetect-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
