First query
In an HTTP Request node, use GET and URLhttps://api.contactship.ai/v1/credits. Configure a header credential named x-api-key with your key as its value. Execute and inspect the response. The node supports method, URL and authentication settings; see the official HTTP Request guide.
This request reads credits; it does not start calls. An authentication failure does not prove the queried endpoint exists.
Add an action
Choose an endpoint from the API reference and use its method, path and parameters. For call creation, check agent, contact or phone and outbound number as required by the endpoint. Test with a controlled destination before connecting a list.Process results
Call initiation and analysis are separate stages. If your flow needs a summary or extracted data, process the analysis event. Keep identifiers to recognize previously processed operations. Do not blindly retry a request that may have started a call: check its status first.Community nodes
If you already use a community node, compare its operations and authentication with this reference. Do not assume every node supports the current endpoints.Frequently asked questions
Do I need a community node?
Do I need a community node?
You can make HTTP requests to the public API. If you choose a dedicated node, verify its authentication and supported operations.
Should I use Bearer or x-api-key?
Should I use Bearer or x-api-key?
The public API documented here uses the
x-api-key header. Do not substitute another service’s authentication scheme.Does an error mean I can retry the call?
Does an error mean I can retry the call?
Not necessarily. Check whether the operation was created before repeating a call-start request.