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

# Launch endpoints

These endpoints prepare a `createLaunch` call. The same fields apply to `validate`, `simulate`, and the MCP tools.

## Parameters

| Field                 | Type         | Rule                                                                                                                                                              |
| --------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `from`                | address      | The signer. Required for `simulate`. Optional for `validate`. Not a private key                                                                                   |
| `name`                | string       | Required. Up to 64 UTF-8 bytes                                                                                                                                    |
| `symbol`              | string       | Required. Up to 32 UTF-8 bytes                                                                                                                                    |
| `imageUri`            | string       | Empty, or `https://` or `ipfs://`. Up to 512 characters                                                                                                           |
| `description`         | string       | Up to 2,000 characters                                                                                                                                            |
| `socialLinks`         | string array | At most 10. `https://`, `ipfs://`, and the agent mark are accepted. Each up to 256 characters                                                                     |
| `repository`          | string       | `https://github.com/owner/repo`. Added to `socialLinks` if absent. See [Build activity link](https://polydash.gitbook.io/polydash-docs/polypad/build-activity.md) |
| `creatorFeeBps`       | integer      | Required. 0 to 500                                                                                                                                                |
| `creatorPayoutWallet` | address      | Zero address means the signer                                                                                                                                     |
| `devBuyEth`           | string       | Wei, base-10 integer string. `0` means no dev buy. Must equal `value`                                                                                             |
| `totalSupply`         | string       | `0` selects 1,000,000,000 tokens. Otherwise 1,000,000 to 1,000,000,000,000 tokens, in 18-decimal base units                                                       |
| `virtualEthReserve`   | string       | `0` selects 1.5 ETH. Otherwise 0.01 ETH to 1,000 ETH, in wei                                                                                                      |
| `launchDelay`         | string       | Seconds. `0` opens trading now. Maximum 2,592,000 (30 days)                                                                                                       |
| `agentMark`           | boolean      | Defaults to `true`. See [Agent-launched badge](https://polydash.gitbook.io/polydash-docs/agents-and-api/agent-launched-badge.md)                                  |

## `POST /api/agents/v1/validate`

Checks parameters and makes no RPC call. A real response for a minimal request:

```json
{
  "ok": true,
  "chainId": 4663,
  "factory": "0xfDfD0A095966c8B56639f7eAa13f4B0188Fc08c2",
  "agentLaunched": true,
  "agentMark": "https://polypad.family/docs#agent-launched",
  "params": {
    "name": "Example",
    "symbol": "EXM",
    "imageUri": "",
    "description": "",
    "socialLinks": ["https://polypad.family/docs#agent-launched"],
    "creatorFeeBps": 100,
    "creatorPayoutWallet": "0x0000000000000000000000000000000000000000",
    "devBuyEth": "0",
    "totalSupply": "0",
    "virtualEthReserve": "0",
    "launchDelay": "0",
    "agentLaunched": true,
    "repository": null
  },
  "custody": "non-custodial"
}
```

## `POST /api/agents/v1/simulate`

Validates, runs `eth_call` against the factory, and returns the unsigned transaction.

```json
{
  "ok": true,
  "chainId": 4663,
  "factory": "0xfDfD0A095966c8B56639f7eAa13f4B0188Fc08c2",
  "agentLaunched": true,
  "unsignedTx": {
    "from": "0x…",
    "to": "0x…",
    "data": "0x…",
    "value": "0",
    "valueHex": "0x0",
    "chainId": 4663
  },
  "simulation": { "success": true, "launch": "0x…", "token": "0x…", "gas": "1200000" },
  "custody": "non-custodial"
}
```

`launch` and `token` are the addresses `eth_call` returned. They match a later broadcast only if the same `from` account sends this calldata at the same nonce.

## `GET /api/agents/v1/marks?from=0x…`

A per-process log of successful simulations for a signer. It is an operator log. It is not the badge, and it is empty on a different server instance.

## API-key launch flow

For integrations that need logo upload and launch limits tracked per key:

1. `POST /api/agents/v1/keys` issues an API key.
2. `POST /api/agents/v1/metadata` uploads a logo (API key).
3. `POST /api/agents/v1/launch/build` returns an unsigned `createLaunch` (API key). Limit: 30 simulations per key per hour, plus per-wallet and per-key launch limits.
4. Sign and send the transaction yourself.
5. `POST /api/agents/v1/launch/register` with `{buildId, txHash}` registers the sent launch.
6. `GET /api/agents/v1/launch/{txHash}` reports status.

Check `GET /api/agents/v1/spec` for the request shapes of the key-based endpoints.

## Signing

Sign `unsignedTx.data` to the factory from `from`. The `value` must be sent with the transaction and must equal `devBuyEth`. The operator is responsible for what the agent launches.


---

# 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://polydash.gitbook.io/polydash-docs/agents-and-api/launch-endpoints.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.
