Link to GitHub

POST /v1/agents/{agent_id}/link

Permission: write:configs
Tokens: API key, CLI user token

Open a pull request containing the definition. Git takes ownership when that pull request merges and syncs.

Path parameters

agent_idstringrequired

{

"path": str,

"repository": str

}

import os

from ellipsis import Ellipsis
from ellipsis import models

client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])

request = models.LinkAgentRequest.model_validate(
    {
      "repository": "api-repo"
    }
)

result = client.agents.link("check-tests", request.repository)
print(result)

import { Ellipsis } from '@ellipsis-dev/sdk';

const client = new Ellipsis({
  apiKey: process.env.ELLIPSIS_API_TOKEN!,
});

const request: Parameters<typeof client.agents.link>[1] = {
  "repository": "api-repo"
};

const result = await client.agents.link("check-tests", request);
console.log(result);

curl -X POST "https://api.ellipsis.dev/v1/agents/{agent_id}/link" \
  -H "Authorization: Bearer $ELLIPSIS_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "repository": "api-repo"
}'

Request

pathstring

File path within the repo. Omit for the default .ellipsis/agents/<slug>.yaml; if set it must be a location the sync scans (a .yaml/.yml file under .ellipsis/ at any depth; in the repository named .ellipsis the repo root is that directory).

repositorystringrequired

Repository name within the caller's account; the owner is always the account, so pass a bare name (e.g. "my-service"), not "owner/my-service".

Response

agentAgentrequired

The agent, still managed through the API until the pull request merges.

pathstringrequired

The file path the definition will be written to.

pull_request_urlstringrequired

The pull request that adds the file. The agent becomes managed by that file once it merges.

Path parameters

Request

Response

On this page