Cannot get API to work - returns message require sign in or sign up

[rsocko]

I am trying to use the Manyfold API on my local instance but have been unsuccessful and could use any help or guidance.

• I am currently running version 0.131.0 in single user mode with the standard Docker Compose setup.
• I can access the API Swagger page at http://IP:Port/api/index.html
• I can test the API with the 'Try it out' button in swagger and it gives me responses from my instance (such as the /collections api shows the results containing my collections.
  • When I run the test in Swagger it shows the curl command as:

curl -X 'GET' \
  'http://IP:PORT/collections?page=1&order=name' \
  -H 'accept: application/vnd.manyfold.v0+json'

• If I try that command or equivalent in PowerShell I get the following message back:

curl : You need to sign in or sign up before continuing.
At line:1 char:1
+ curl -Uri "https://IP:PORT/collections" `
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (System.Net.HttpWebRequest:HttpWebRequest) [Invoke-WebRequest], WebException
    + FullyQualifiedErrorId : WebCmdletWebResponseException,Microsoft.PowerShell.Commands.InvokeWebRequestCommand

• If I try to go to the url of IP:Port/API/Collections I get a 404 error as that page doesn't exist.

  • If I try the 'try it out' in Swagger for either of the NodeInfo commands (/.well-known/nodeinfo or /nodeinfo/2.0) it returns a 404 error.

• I see the OAuth Application section in the Settings.

  • In fact I have created several to test. But I can't figure out how to call the OAuth flow itself to get an access token.
  • Additionally (not sure if related) but if I try to edit or delete any of the OAuth Applications I created I get a 404 error

Do I need to enable multi-user or some other setting to get the API to work?
Could anyone point me to the right changes or setup to be able to use the API?

My COMPOSE file:

services:
  app:
    image: ghcr.io/manyfold3d/manyfold:latest
    container_name: manyfold_app
    ports:
      - 3214:3214
    volumes:
      # Uncomment to add a filesystem volume for your model library (or multiple if
      # you want multiple libraries), in the form <local_path>:<container_path>.
      # The local path could be a folder that already contains models, in which case Manyfold
      # will scan and import them, or it could be empty.
      # The container path can be anything; you will need to enter it in the "new library" form.
      # - /local/path/to/your/models:/models
      - C:\Users\USER\OneDrive\3D\Models:/models
    environment:
      DATABASE_ADAPTER: postgresql # mysql2 or sqlite3 are also supported
      DATABASE_HOST: postgres-server
      DATABASE_PORT: 5432 # only needed for non-standard ports
      DATABASE_NAME: manyfold_database # or the path to the database file if using sqlite3
      DATABASE_USER: ${DATABASE_USER}
      DATABASE_PASSWORD: ${DATABASE_PASSWORD}
      SECRET_KEY_BASE: ${SECRET_KEY_BASE}
      REDIS_URL: redis://redis-server:6379/1
      PUID: 1000
      PGID: 1000
      # For details of other optional environment variables, including features such
      # as multiuser mode, visit https://manyfold.app/sysadmin/configuration.html
    restart: unless-stopped
    depends_on:
      - postgres-server
      - redis-server
    networks:
      - manyfold
    # Optional, but recommended for better security
    security_opt:
      - no-new-privileges:true
    cap_drop:
      - ALL
    cap_add:
      - CHOWN
      - DAC_OVERRIDE
      - SETUID
      - SETGID

  postgres-server:
    image: postgres:15
    container_name: manyfold_db
    volumes:
      - db_data:/var/lib/postgresql/data
    environment:
      POSTGRES_USER: ${DATABASE_USER}
      POSTGRES_PASSWORD: ${DATABASE_PASSWORD}
    restart: unless-stopped
    networks:
      - manyfold

  redis-server:
    image: redis:7
    container_name: manyfold_redis
    restart: unless-stopped
    networks:
      - manyfold

volumes:
  db_data:

networks:
  manyfold:

[rsocko]

I have been able to figure out the issue and solution. Using Copilot chat within VSCode proved incredibly helpful.

My learnings (in case it helps others):

• The API requires OAuth2 authentication flow.
• Tokens are issued at IP:Port/oauth/token (good for 2 hours)
• That token then gets passed within the request header to the API

It would be great to update the documentation to provide more details about the API, usage, etc. (such as the oauth/token URL).

[Floppy]

That's all true, and I can improve the documentation to make that clearer. The authorize button at the top of the API docs handles the OAuth flow for you for the "try it out" button, but I'm surprised it didn't show you an error that auth was needed before letting you executing the query. I'll investigate, see if there's anything I can improve there!