---
title: "Launches a custom agent tool via CodeAPI"
method: POST
path: "/agents/custom_tools/{tool_id}/launch"
tags: ["Agents"]
---

# Launches a custom agent tool via CodeAPI

`POST /agents/custom_tools/{tool_id}/launch`

## Request

- Base URL: `https://h2ogpte.genai.h2o.ai/api/v1`
- URL: `https://h2ogpte.genai.h2o.ai/api/v1/agents/custom_tools/{tool_id}/launch`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/h2o/apis/h2ogpte-rest-api/docs/agents/custom_tools/:tool_id/launch/post.ts> (a function with typed inputs; its response is checked against the schema)

Launches a custom agent tool using CodeAPI and stores the endpoint URL.

## Path parameters

- `tool_id` string, uuid, required

## Response `200`

Successful operation

- object
  - `codeapi_job_id` string: The ID of the launched CodeAPI job
  - `codeapi_url` string: The HTTP endpoint URL for the launched tool

## Other responses

- `401`: Unauthorized - Invalid or missing API key
- `404`: Not found
- `500`: Internal server error
- `default`: Unexpected error

---

[API](https://skmtc.dev/h2o/apis/h2ogpte-rest-api.md) - [All operations](https://skmtc.dev/h2o/apis/h2ogpte-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/h2o/apis/h2ogpte-rest-api/revisions/a82a117320f4?raw)