test.guide REST API Skill

Scope

Use this skill for external programs that call test.guide through HTTP REST APIs.

• Interface: OpenAPI 3 YAML specs bundled under references/restapi-docs.
• Authentication: the specs define TestGuideAuthKey and/or BearerAuth; verify the target spec before generating code.
• Base URL pattern: combine the user's test.guide host with the server path in the relevant spec, for example /api/report, /api/artifact, or /api/execution.
• Some deployments use a context path such as /test-guide; use the matching server entry from the spec when needed.

Do not use this skill for flow.kit block graph authoring. Use testguide-flowkit-skill when the task is about flow_definition.py, FlowBuilder, blocks, bundle validation, or flow visualization.

Bundled OpenAPI Specs

Read the relevant YAML before writing endpoint paths, payloads, response parsing, or polling logic.