Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.61 KB

deploy-api.md

File metadata and controls

34 lines (25 loc) · 1.61 KB

Deploy API

One of the main features of ABI is the ability to deploy an Agentic Based API.

The API deployment is automated through GitHub Actions. Every time you push to the main branch with last commit message as feat: or fix:, the API will be deployed as follow:

  1. A new container is built (via the "Build ABI Container" workflow)
  2. The deployment workflow creates/updates a NAAS space with the latest container image
  3. The API will be accessible through the NAAS platform once deployment is complete as the following URL: https://<github_project_repository.name>-api.default.space.naas.ai/

Setup Requirements

  1. Create a GitHub Classic Personal Access Token:

    • Go to GitHub Settings > Developer Settings > Personal Access Tokens > Tokens (classic)
    • Generate a new token with the following permissions:
      • repo (Full control of private repositories)
      • read:packages and write:packages (For container registry access)
    • Copy the token value

  2. Get required API keys:

    • OpenAI API key from OpenAI Platform
    • NAAS Credentials JWT Token from your NAAS account

  3. Navigate to your repository's Settings > Secrets and variables > Actions and add the following secrets:

    • ACCESS_TOKEN: Your GitHub Classic Personal Access Token
    • OPENAI_API_KEY: Your OpenAI API key
    • NAAS_CREDENTIALS_JWT_TOKEN: Your NAAS Credentials JWT Token
    • ABI_API_KEY: Your key to access the API

Monitoring

  • Go to your repository's Actions tab
  • Look for the "ABI API" workflow
  • Check the latest workflow run for deployment status and logs