Reference

Support

View as Markdown

This guide explains how to get help when working with AISquare APIs.

Overview

If you encounter issues while integrating or using AISquare APIs, you can reach out through the available support channels.

Contact support

For technical assistance, contact:

When to reach out

Contact support if:

  • API requests consistently fail
  • Authentication issues cannot be resolved
  • Unexpected errors (500) occur
  • Data returned is inconsistent or incorrect
  • Access or permission issues are unclear

Information to include

When reaching out, include:

  • Endpoint used
  • Request method (GET, POST, etc.)
  • Request payload (if applicable)
  • Response status code
  • Error message
  • Timestamp of request

Example

Endpoint: POST /api/v1/aistudios/metrics/
Status: 403
Body: { "url": "ai-research-studio" }

Best practices

Provide reproducible details

Include exact request and response information.

Avoid sharing sensitive data

Do not include:

  • API keys
  • Tokens
  • Personal user data

Check documentation first

Verify:

  • Required parameters
  • Authentication method
  • Access control rules

Response expectations

Support responses may include:

  • Clarification on API usage
  • Debugging assistance
  • Issue confirmation and resolution steps