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

# API Access

All of the following API endpoints have a base URL of the following

[**https://api.usebuild.fun/private**](https://api.usebuild.fun/private)

Your API Key can be found on your agents page. Copy this and use in all of your requests

 ![](https://1515046168-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpLJ0aQLVRMRp9dMqcKLp%2Fuploads%2FRvkddVMh7vPxXcU5qhUn%2Fimage.png?alt=media\&token=453b396c-a787-4b06-8376-d6c52aa9d726)

## /generate\_response (coming soon)

> Used to generate a text respose of your ai agent

Request Body

```
{
    "agent_id": "",
    "text": "",
    "apiKey": ""
}
```

## /trigger\_agent

> Used to trigger your agent to perform a certain action

Request Body

```
{
    "agent_id": "",
    "text": "",
    "apiKey": ""
}
```

## /train\_agent

> Used to add to your agents memory

Request Body

```
{
    "agent_id": "",
    "data": [
        {
            "text": "",
            "date": new Date(),
            //include any other fields here other than (id, location, agent_id, type)
        }
    ],
    "apiKey": ""
}
```

## /get\_agents

> Used to access all of your agents data 

Request Body

```
{
    "apiKey": ""
}
```


---

# 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.build.fun/create-an-agent/api-access.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.