diff --git a/docs/web-apis/autorouting-api.mdx b/docs/web-apis/autorouting-api.mdx index 9454e2a7..fb217410 100644 --- a/docs/web-apis/autorouting-api.mdx +++ b/docs/web-apis/autorouting-api.mdx @@ -19,9 +19,26 @@ own cloud autorouter. ## Using Custom Autorouters -Here's an example of how a customer autorouter can be configured with tscircuit: +tscircuit provides several ways to configure autorouting: - ( ) -`} /> +`} +/> ### The Autorouter Object @@ -203,7 +221,6 @@ type SimplifiedPcbTraces = Array<{ }> ``` - ### Circuit JSON Input/Output When using `inputFormat: "circuit_json"` you the API must accept `{ input_circuit_json }` and @@ -221,9 +238,9 @@ to correspond to what you've implemented. ## The `solve-endpoint` API -| Endpoint | Description | -| -------- | ----------- | -| `/autorouting/solve` | Takes autorouting input and returns the solved routes | +| Endpoint | Description | +| -------------------- | ----------------------------------------------------- | +| `/autorouting/solve` | Takes autorouting input and returns the solved routes | ### `solve-endpoint` with `simplified` input @@ -276,11 +293,11 @@ RESPONSE: The `job` autorouting API allows you to perform long-running autorouting jobs for large circuits. When using the `job` API, you must use the `"circuit_json"` input format. -| Endpoint | Description | -| -------- | ----------- | -| `/autorouting/jobs/create` | Create the autorouting job | -| `/autorouting/jobs/get` | Get the status of the autorouting job | -| `/autorouting/jobs/cancel` | Cancel the autorouting job | +| Endpoint | Description | +| ------------------------------ | ------------------------------------------------------ | +| `/autorouting/jobs/create` | Create the autorouting job | +| `/autorouting/jobs/get` | Get the status of the autorouting job | +| `/autorouting/jobs/cancel` | Cancel the autorouting job | | `/autorouting/jobs/get_output` | Get the solved routes from a completed autorouting job | :::info @@ -339,8 +356,8 @@ RESPONSE: Additional configuration parameters can be passed to either the `/autorouting/jobs/create` endpoint or the `/autorouting/solve` endpoint to configure the autorouter. -| Parameter | Example Value | Description | -| --------- | ------------- | ----------- | -| `display_name` | `"Nine-key Macropad"` | A display name for the autorouting job. Useful for debugging! | -| `provider` | `"freerouting"` | The autorouting algorithm to use | +| Parameter | Example Value | Description | +| --------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| `display_name` | `"Nine-key Macropad"` | A display name for the autorouting job. Useful for debugging! | +| `provider` | `"freerouting"` | The autorouting algorithm to use | | `subcircuit_id` | `"subcircuit_source_group_1"` | To support subcircuit autorouting, you must accept this parameter and only solve for the subset of routes within the subcircuit. |